Command line reference
Run masko COMMAND --help for the same text offline. Every command accepts --json, which prints machine-readable output.
Account
| Command | Result |
|---|---|
masko login | Sign in through your browser. Options: --no-browser, --device, --api-key, --api-key-stdin, --scope read|write, --name NAME, --timeout SECS. |
masko whoami | Show your account, workspace, permissions and credits. |
masko credits | Show total, subscription and top-up credits. |
masko logout | Sign out of the saved login. An API key you set in MASKO_API_KEY still applies. |
Studio API
masko studio METHOD PATH [--file FILE] [--json]METHOD is GET, POST, PATCH or DELETE. PATH starts with mascots, canvases, projects, jobs, assets or upload. --file sends a JSON body. GET takes no body. See masko help studio for examples.
Assets
| Command | Result |
|---|---|
masko assets show ASSET_ID | Show one asset. |
masko assets download ASSET_ID --output PATH | Download one asset. --format selects original or the asset type. Existing files are never overwritten. |
To list assets, use masko studio GET 'assets?mascot_id=MASCOT_ID' --json.
Environment and global options
| Setting | Use |
|---|---|
--api-url URL or MASKO_API_URL | Select the backend, for local development. |
MASKO_API_KEY | Use an API key. It overrides the saved login. |
--json | Print JSON. Diagnostics go to stderr. |
--help, -h | Read help without connecting or changing anything. |
--version | Print the CLI version. |