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#
Usage
tiled [OPTIONS] COMMAND [ARGS]...
admin#
Administrative utilities for managing large deployments.
Usage
tiled admin [OPTIONS] COMMAND [ARGS]...
api-key#
Manage API keys for Principals.
Usage
tiled admin api-key [OPTIONS] COMMAND [ARGS]...
create#
Create an API key for a Principal.
Usage
tiled admin api-key create [OPTIONS] {principal_uuid}
list#
List API keys for a Principal.
Usage
tiled admin api-key list [OPTIONS] {principal_uuid}
revoke#
Revoke an API key for a Principal.
Usage
tiled admin api-key revoke [OPTIONS] {principal_uuid} {first_eight}
check-config#
Check configuration file for syntax and validation errors.
Usage
tiled admin check-config [OPTIONS] [config_path]
create-service-principal#
Create a new service principal. The new principal will have a random UUID.
Usage
tiled admin create-service-principal [OPTIONS]
downgrade-database#
Downgrade the database schema to a prior version.
Usage
tiled admin downgrade-database [OPTIONS] {database_uri} {revision}
initialize-database#
Initialize a SQL database for use by Tiled.
Usage
tiled admin initialize-database [OPTIONS] {database_uri}
list-principals#
List information about all Principals (users or services) that have ever logged in.
Usage
tiled admin list-principals [OPTIONS] [page_offset] [page_limit]
show-principal#
Show information about one Principal (user or service).
Usage
tiled admin show-principal [OPTIONS] {uuid}
upgrade-database#
Upgrade the database schema to the latest version.
Usage
tiled admin upgrade-database [OPTIONS] {database_uri} [revision]
api_key#
Create, list, and revoke API keys.
Usage
tiled api_key [OPTIONS] COMMAND [ARGS]...
create#
Usage
tiled api_key create [OPTIONS]
list#
Usage
tiled api_key list [OPTIONS]
revoke#
Usage
tiled api_key revoke [OPTIONS] {first_eight}
catalog#
Manage a catalog of data to be served by Tiled.
Usage
tiled catalog [OPTIONS] COMMAND [ARGS]...
downgrade-database#
Upgrade the catalog database schema to the latest version.
Usage
tiled catalog downgrade-database [OPTIONS] {database_uri} {revision}
init#
Initialize a database as a Tiled Catalog.
Examples:
# Using a simple local file as an embedded “database” (SQLite) tiled init catalog.db tiled init path/to/catalog.db tiled init sqlite:////path/to/catalog.db
# Using a client/serve database engine (PostgreSQL) tiled init postgresql://username:password@localhost/database_name:5432
Usage
tiled catalog init [OPTIONS] [database]
serve#
Serve a catalog.
Usage
tiled catalog serve [OPTIONS] [database]
upgrade-database#
Upgrade the catalog database schema to the latest version.
Usage
tiled catalog upgrade-database [OPTIONS] {database_uri} [revision]
login#
Log in to an authenticated Tiled server.
Usage
tiled login [OPTIONS]
logout#
Log out.
Usage
tiled logout [OPTIONS]
profile#
Examine Tiled ‘profiles’ (client-side config).
Usage
tiled profile [OPTIONS] COMMAND [ARGS]...
clear-default#
Clear the default Tiled profile.
Usage
tiled profile clear-default [OPTIONS]
create#
Create a ‘profile’ that can be used to connect to a Tiled server.
Usage
tiled profile create [OPTIONS] {uri}
delete#
Usage
tiled profile delete [OPTIONS] {name}
edit#
Show the content of a profile.
Usage
tiled profile edit [OPTIONS] {profile_name}
get-default#
Show the current default Tiled profile.
Usage
tiled profile get-default [OPTIONS]
list#
List the profiles (client-side configuration) found and the files they were read from.
Usage
tiled profile list [OPTIONS]
paths#
List the locations that the client will search for profiles (client-side configuration).
Usage
tiled profile paths [OPTIONS]
set-default#
Set the default Tiled profile.
Usage
tiled profile set-default [OPTIONS] {profile_name}
show#
Show the content of a profile.
Usage
tiled profile show [OPTIONS] {profile_name}
register#
Usage
tiled register [OPTIONS] {uri} {filepath}
serve#
Launch a Tiled server.
Usage
tiled serve [OPTIONS] COMMAND [ARGS]...
catalog#
Serve a catalog.
Usage
tiled serve catalog [OPTIONS] [database]
config#
Serve a Tree as specified in configuration file(s).
Usage
tiled serve config [OPTIONS] [config_path]
demo#
Start a public server with example data.
Usage
tiled serve demo [OPTIONS]
directory#
Serve a Tree instance from a directory of files.
Usage
tiled serve directory [OPTIONS] {directory}
pyobject#
Serve a Tree instance from a Python module.
Usage
tiled serve pyobject [OPTIONS] {object_path}
tree#
Show the names of entries in a Tree.
This is similar to the UNIX utility tree for listing nested directories.
Usage
tiled tree [OPTIONS] [max_lines]
whoami#
Show logged in identity.
Usage
tiled whoami [OPTIONS]