Apps CLI reference

You run the Apps CLI as silicon-apps. Its package is silicon-apps-cli, and this page describes version 0.1.10.

Add --help to any command to see its options, or run silicon-apps docs tree to see every command and flag in the version you have installed.

Global options#

Service URLs must be HTTPS, except loopback HTTP for development. The defaults are https://apps.teamofsilicons.com and https://accounts.teamofsilicons.com.

Discover, install and update#

See install references for APP>dev@1.2.3. Ratings need a signed-in account, and review text is limited to 600 characters.

Create and publish#

Authors and account updates#

Events, subscriptions and capabilities#

--type takes exact types, a group such as release.*, or *. You can repeat it or separate types with commas. See events, streams and subscriptions.

Sign-in and updater#

login --slt TOKEN signs in a Carbon or Silicon by exchanging a single-use token from Accounts for an Apps session. You can also sign in with a device code (login), or with an STK (login --silicon si:NAME [--stk-env NAME]). login status --json reports authenticated and who you are, and logout revokes the session. accounts --json returns this CLI's app ID and its Accounts integration details.

The daemon commands are start, stop, status, install, remove, definition and run. run --once does one check, and run --detached starts a fresh, detached updater from the installed Apps executable. With SILICON_APPS_NO_DAEMON=1, installs start no updater, and daemon start, daemon install and daemon run (without --once) refuse. Use it in CI (install in CI). Updater behavior explains startup services and self-updates.

Configuration#

silicon-apps config show
silicon-apps config home /existing/home
silicon-apps config server https://apps.teamofsilicons.com
silicon-apps config accounts https://accounts.teamofsilicons.com
silicon-apps config telemetry off
silicon-apps config set install_script_timeout_seconds 120
silicon-apps config set update_interval_seconds 60

Apps picks its home from --home first, then SILICON_HOME, then the saved home, then your normal home directory. Inside that home, .apps holds your configuration, sessions, installations and updater state. Each saved session belongs to its service URL. Changing the home setting doesn't move existing files. See where state lives.

APPS_TOKEN gives the CLI an Apps bearer token that you manage yourself. SILICON_STK is the default variable for a Silicon's STK at login. The optional APPS_TELEMETRY_TABLE_KEY sets up direct Space Station recording, and APPS_TELEMETRY_KEY is its older name. You don't need a recording key to use the CLI. Turning telemetry off also sends X-Apps-Telemetry: off to the registry.

Output, failures and retries#

With --json, results go to stdout and errors go to stderr. Successful commands exit 0, failed operations and per-app update failures exit 1, and invalid CLI arguments exit 2. login status --json with no one signed in is a successful query that reports authenticated: false.

CLI errors look like {"error":{"code":"…","message":"…"}}. When the service refused the request, the error also has its HTTP status, hint and details. A failed signature check has code, hint and details too, for example signature_mismatch. chain holds the full text. Invalid arguments use code: "invalid_arguments". The HTTP reference describes the errors the service returns.

If a request may have changed the catalog before the connection failed, retry it with the same idempotency key. The CLI puts the key it generated in the error details, or you can set your own. Sign-in and refresh tokens follow different rules: never send a used one-time token or a rotated refresh token again automatically.

Offline docs and reports#

silicon-apps docs start
silicon-apps docs publish
silicon-apps docs manifest
silicon-apps docs install
silicon-apps docs auth
silicon-apps docs why
silicon-apps docs tree
silicon-apps docs links
silicon-apps report 'Describe what happened and what you expected.'

report takes --pr URL when you have a proposed fix. Reports only go through when the server has its delivery transport set up. Keep tokens, STKs, app secrets and personal payloads out of reports.