Command-line tool

Installing tiled adds a command-line tool, tiled, to the environment. Use tiled --help for info, or see the documentation below.

tiled

tiled [OPTIONS] COMMAND [ARGS]...

Options

--install-completion <install_completion>

Install completion for the specified shell.

Options

bash | zsh | fish | powershell | pwsh

--show-completion <show_completion>

Show completion for the specified shell, to copy it or customize the installation.

Options

bash | zsh | fish | powershell | pwsh

admin

Administrative utilities for managing large deployments.

tiled admin [OPTIONS] COMMAND [ARGS]...

check-config

Check configuration file for syntax and validation errors.

tiled admin check-config [OPTIONS] [CONFIG_PATH]

Arguments

CONFIG_PATH

Optional argument

downgrade-database

Upgrade the database schema to the latest version.

tiled admin downgrade-database [OPTIONS] DATABASE_URI REVISION

Arguments

DATABASE_URI

Required argument

REVISION

Required argument

initialize-database

Initialize a SQL database for use by Tiled.

tiled admin initialize-database [OPTIONS] DATABASE_URI

Arguments

DATABASE_URI

Required argument

upgrade-database

Upgrade the database schema to the latest version.

tiled admin upgrade-database [OPTIONS] DATABASE_URI [REVISION]

Arguments

DATABASE_URI

Required argument

REVISION

Optional argument

api_key

Create, list, and revoke API keys.

tiled api_key [OPTIONS] COMMAND [ARGS]...

create

tiled api_key create [OPTIONS] URI_OR_PROFILE

Options

--expires-in <expires_in>

Number of seconds until API key expires. If None, it will never expire or it will have the maximum lifetime allowed by the server.

--scopes <scopes>

Restrict the access available to this API key by listing scopes. By default, it will inherit the scopes of its owner.

--note <note>

Add a note to label this API key.

--no-verify

Skip SSL verification.

Default

False

Arguments

URI_OR_PROFILE

Required argument

list

tiled api_key list [OPTIONS] URI_OR_PROFILE

Options

--no-verify

Skip SSL verification.

Default

False

Arguments

URI_OR_PROFILE

Required argument

revoke

tiled api_key revoke [OPTIONS] URI_OR_PROFILE FIRST_EIGHT

Options

--no-verify

Skip SSL verification.

Default

False

Arguments

URI_OR_PROFILE

Required argument

FIRST_EIGHT

Required argument

download

Download content from a Tree to an on-disk cache.

tiled download [OPTIONS] URI_OR_PROFILE CACHE_PATH

Options

--available-bytes <available_bytes>
--no-verify

Skip SSL verification.

Default

False

Arguments

URI_OR_PROFILE

Required argument

CACHE_PATH

Required argument

login

Log in to an authenticated Tiled server.

tiled login [OPTIONS] URI_OR_PROFILE

Options

--no-verify

Skip SSL verification.

Default

False

--show-secret-tokens

Show secret tokens after successful login.

Default

False

--refresh-or-fail

Refresh authentication or exit with failure.

Default

False

Arguments

URI_OR_PROFILE

Required argument

logout

Log out from one or all authenticated Tiled servers.

tiled logout [OPTIONS] [URI_OR_PROFILE]

Arguments

URI_OR_PROFILE

Optional argument

profile

Examine Tiled ‘profiles’ (client-side config).

tiled profile [OPTIONS] COMMAND [ARGS]...

list

List the profiles (client-side configuration) found and the files they were read from.

tiled profile list [OPTIONS]

paths

List the locations that the client will search for profiles (client-side configuration).

tiled profile paths [OPTIONS]

show

Show the content of a profile.

tiled profile show [OPTIONS] PROFILE_NAME

Arguments

PROFILE_NAME

Required argument

serve

Launch a Tiled server.

tiled serve [OPTIONS] COMMAND [ARGS]...

config

Serve a Tree as specified in configuration file(s).

tiled serve config [OPTIONS] [CONFIG_PATH]

Options

--public

Turns off requirement for API key authentication for reading. However, the API key is still required for writing, so data cannot be modified even with this option selected.

Default

False

--host <host>

Bind socket to this host. Use –host 0.0.0.0 to make the application available on your local network. IPv6 addresses are supported, for example: –host ‘::’. Uses value in config by default.

--port <port>

Bind to a socket with this port. Uses value in config by default.

Arguments

CONFIG_PATH

Optional argument

directory

Serve a Tree instance from a directory of files.

tiled serve directory [OPTIONS] DIRECTORY

Options

--public

Turns off requirement for API key authentication for reading. However, the API key is still required for writing, so data cannot be modified even with this option selected.

Default

False

--keep-ext

Serve a file like ‘measurements.csv’ as its full filepath with extension, instead of the default which would serve it as ‘measurements’. This is discouraged because it leaks details about the storage format to the client, such that changing the storage in the future may break user (client-side) code.

Default

False

--poll-interval <poll_interval>

Time in seconds between scans of the directory for removed or changed files. If 0, do not poll for changes.

--host <host>

Bind socket to this host. Use –host 0.0.0.0 to make the application available on your local network. IPv6 addresses are supported, for example: –host ‘::’.

Default

127.0.0.1

--port <port>

Bind to a socket with this port.

Default

8000

--data-cache <object_cache_available_bytes>

Maximum size for the object cache, given as a number of bytes as in 1_000_000 or as a fraction of system RAM (total physical memory) as in 0.3. Set to 0 to disable this cache. By default, it will use up to 0.15 (15%) of RAM.

Arguments

DIRECTORY

Required argument

pyobject

Serve a Tree instance from a Python module.

tiled serve pyobject [OPTIONS] OBJECT_PATH

Options

--public

Turns off requirement for API key authentication for reading. However, the API key is still required for writing, so data cannot be modified even with this option selected.

Default

False

--host <host>

Bind socket to this host. Use –host 0.0.0.0 to make the application available on your local network. IPv6 addresses are supported, for example: –host ‘::’.

Default

127.0.0.1

--port <port>

Bind to a socket with this port.

Default

8000

--data-cache <object_cache_available_bytes>

Maximum size for the object cache, given as a number of bytes as in 1_000_000 or as a fraction of system RAM (total physical memory) as in 0.3. Set to 0 to disable this cache. By default, it will use up to 0.15 (15%) of RAM.

Arguments

OBJECT_PATH

Required argument

sessions

List all authenticated Tiled sessions.

tiled sessions [OPTIONS]

Options

--show-secret-tokens

Show secret (refresh) tokens.

Default

False

tree

Show the names of entries in a Tree.

This is similar to the UNIX utility tree for listing nested directories.

tiled tree [OPTIONS] URI_OR_PROFILE [MAX_LINES]

Options

--no-verify

Skip SSL verification.

Default

False

Arguments

URI_OR_PROFILE

Required argument

MAX_LINES

Optional argument