Appearance

ts help ​

List every command this build of ts supports, or show the usage, actions, and options for one of them. It is the fastest way to confirm an option's exact spelling before you script it.

Usage ​

text
ts help
ts help <command>
ts <command> --help

Description ​

ts help with no argument prints the command list — every command name with a one-line summary, in alphabetical order. Running ts with no arguments at all prints the same list.

ts help <command> prints that command's summary, its usage line, and its options. For commands that take actions, the usage line is followed by a short note listing the valid actions and any settable properties — that note is the authoritative list, and it is worth reading before assuming an action exists.

ts <command> --help produces exactly the same page, so you do not have to back out of what you were typing.

Help is generated from the built binary, so it always describes the build you are running rather than the build the documentation was written against. It contacts no server and needs no login.

Asking for help on something that is not a command prints <name> is not a ts command. See 'ts help'. on standard error and exits 9009. Scripts can use that to probe whether a command exists in the installed build.

Examples ​

bash
# What can this build do?
ts help

# Usage, actions, and options for one command
ts help workspace

# The same page, without abandoning the line you are typing
ts workspace --help

# Probe whether a command exists before scripting against it
ts help storage-scope > /dev/null 2>&1 && echo present
bash
# Help is always plain text: --format is accepted but ignored
ts help version --format=json

Exit Codes ​

0 when help is printed, whether for the whole CLI or one command. 9009 when the argument does not name a command in this build.

  • ts version — Which build of ts is producing this help.
  • ts config — The stored settings, including the default server.

Turbo.net © 2025