CLI commands
The tabletop CLI (command line tool) lets you, a script or an AI agent use tabletop from a terminal. Each action command does the same thing as an MCP tool.
note
A download of the CLI is not available yet. To ask about it, see Get help.
Sign in
| Command | What it does |
|---|---|
tabletop login | Opens a sign-in page in your browser. After you sign in, the CLI keeps your sign-in in the keychain of your computer. |
tabletop logout | Removes your sign-in from your computer. |
tabletop org use ORG_ID | Sets the org that the commands use when you do not give --org. |
tabletop mcp proxy | Gives the MCP tools to an agent on your computer, with the sign-in of the CLI. Add this command to the MCP settings of the agent. |
Options
Each action command takes these options:
| Option | What it does |
|---|---|
--org ORG_ID | The org of the command. Without it, the command uses the org of tabletop org use. |
--token TOKEN | An API token of the org, for scripts. Without it, the CLI uses the sign-in of tabletop login. You can also set the TABLETOP_TOKEN environment variable. |
--body JSON | The data that the command sends: JSON text, @FILE for a file, or - to read it from the input. Only some commands take it. |
--raw | Prints the result as JSON on one line. |
--help | Shows the options of the command. |
Some commands take more options, such as --workflow WORKFLOW_ID. Run the command with --help to see them.
The token scope of a command is the permission that its API token must have. The app shows the scopes when you make a token.
Activity
| Command | What it does | Token scope |
|---|---|---|
tabletop activity list | List the activity of an org: runs, workflows made and deleted, and member changes. | Read workflows |
Workflows
| Command | What it does | Token scope |
|---|---|---|
tabletop workflows browse | List and search the workflows of each of your orgs. | Read workflows |
tabletop workflows list | List and search the workflows. | Read workflows |
tabletop workflows get | Get a workflow. | Read workflows |
tabletop workflows create | Make an empty workflow. | Change workflows |
tabletop workflows rename | Rename a workflow. | Change workflows |
tabletop workflows duplicate | Copy a workflow. | Change workflows |
tabletop workflows delete | Move a workflow to the trash for 30 days. | Change workflows |
tabletop workflows restore | Take a workflow out of the trash. | Change workflows |
tabletop workflows import | Make a workflow from a workflow file. | Change workflows |
tabletop workflows edit-graph | Add, link, change and remove nodes of a workflow. | Change workflows |
tabletop workflows export | Get a workflow as a workflow file. | Read workflows |
Templates
| Command | What it does | Token scope |
|---|---|---|
tabletop starters list | List the templates that you can copy into your org. | Read workflows |
tabletop starters use | Copy a template into your org with the result of each node. | Change workflows |
Runs
| Command | What it does | Token scope |
|---|---|---|
tabletop runs start | Run a workflow, or some of its nodes with the nodes they need. | Start runs |
tabletop runs quote | Get the most tokens that a run of a workflow holds. | Start runs |
tabletop runs get | Get a run with the state and outputs of each node run. | Read workflows |
tabletop runs list | List the runs of a workflow, newest first. | Read workflows |
tabletop runs latest | Get the node run that each node of a workflow shows: a running one, else its newest result. | Read workflows |
tabletop runs versions | List the versions of a node of a workflow, newest first. | Read workflows |
tabletop runs use-version | Make the outputs of a node run the current versions of its node. The next run takes them. | Change workflows |
tabletop runs cancel | Cancel a run: waiting nodes end at once, running nodes stop. | Start runs |
tabletop runs node-run | Get a node run with its state and outputs. | Read workflows |
tabletop runs log | Read the log of a node run. | Read workflows |
tabletop runs approve | Approve a node run that waits for approval, so the nodes after it run. | Start runs |
Billing
| Command | What it does | Token scope |
|---|---|---|
tabletop billing wallet | Get the tokens of an org: balance, held and debt. | Read billing |
Last updated on