Docs / CLI command reference

CLI command reference

Install the CLI and connect your project. Find commands, report problems, suggest improvements and revoke tokens.

Install and check your version

The JoripSpace CLI lets you connect a project and manage deployments, data and settings from a terminal. This guide covers CLI 0.6.1. Run the commands below to check your version, install the latest npm release and confirm the update.

CLI

joripspace --version
npm view @joripspace/cli@latest version
npm install -g @joripspace/cli@latest
joripspace --version

You need Node.js 18 or later and npm. To run without a global installation, use npx -y @joripspace/cli@latest. Replace PROJECT in the examples with your existing project name.

If the version stays the same after an update, your terminal may still be using an older installation. Check its location with Get-Command joripspace -All in PowerShell or command -v joripspace on macOS and Linux.

Connect a project

CLI

joripspace login
joripspace projects
joripspace start PROJECT --json

Run login, approve the connection in your browser and enter the one-time code within five minutes. You can then list your projects and connect one with start. The response shows its current state and what to do next. For an AI agent, use login --code "CONNECTION_CODE" --json to pass the code without an interactive prompt.

If you need a new project, run create --name NAME and complete the required agreements. Your CLI login is saved on your computer, so you can reuse it later. An MCP client has its own sign-in process.

To work in another folder, add --cwd "PROJECT_FOLDER". The connected project name is saved in .joripspace/project. Keep the local login file, .env.joripspace, out of Git, deployments and checkpoints. When you finish, logout removes the saved login. To disable an exposed token on the server as well, see the token revocation section below.

Command reference

Find the task you want to perform in the table below. The CLI help shows the available options, and commands such as deploy and report have their own help pages. If a command returns the general help page, look up its name and options in that list.

Command	Purpose
`login · logout`	Sign in or remove a saved login
`me · projects · get`	Read accessible projects and project status
`create · start · link`	Create a project or connect an existing one
`templates · template list · install-template · template pull`	Find, install and update templates
`db schema · db query · db migrate`	Inspect schemas, execute SQL and apply migrations
`storage list · storage get · storage put · storage delete`	List, read, upload and delete stored files
`deploy · deployments · deployment get · deployment pull · rollback`	Deploy, inspect history, restore source and roll back
`checkpoint save · list · get · update · restore · deploy · delete`	Manage checkpoints, restore locally and deploy
`secret list · generate · set · update`	View Secret names, generate, register and replace keys
`domains · domain create · verify · delete`	Connect, verify and remove domains
`crons · cron create · run · delete`	Manage and run scheduled jobs
`mail connect · status · test`	Connect mail, check status and send a test
`realtime-v2 status · activate · rotate · keys · revoke-key · docs`	Manage realtime activation and signing keys
`events · usage-summary · usage-breakdown`	Read runtime events and usage
`github prepare · knowledge search`	Prepare GitHub workflows and search operating guidance
`report`	Submit problems, bugs and improvement suggestions
`tokens current · tokens revoke`	Find a token ID or revoke a token

CLI

joripspace --help
joripspace deploy --help
joripspace report --help

Flag	Behavior
`--project PROJECT`	Choose the project for a command that supports this option.
`--cwd PATH`	Use this folder to find the project and its saved login.
`--json`	Return results as JSON for agents and scripts, without opening a browser or waiting for input. Permissions and required agreements still apply.
`--api-url URL`	Set the API address to connect to.

Report a problem or suggest an improvement

CLI

joripspace report --project PROJECT --category bug --summary "Deployment status is incorrect" --details "Reproduction steps" --json
joripspace report --project PROJECT --category feedback --summary "Add deployment history filters" --expected "Search by label" --json

The report command sends a project-related problem or suggestion to JoripSpace. Choose problem for a general issue, bug for a defect or feedback for an improvement idea. To suggest an improvement, use report --category feedback. The feedback category and dedicated report help are available in CLI 0.6.1 and later.

Connect a project and write a short summary. You can add context with --details, describe the desired and current behavior with --expected and --actual, or include an error code with --error-code. CLI, Node.js and OS information is attached automatically.

Review the content before sending and leave out credentials, personal data and private source. If you are working with an agent, ask it to submit the report when you are ready. A successful response includes a receipt number, report_id. If the response is interrupted, the report may already have been received, so avoid sending the same report repeatedly.

Revoke an exposed connection token

CLI

joripspace tokens current
joripspace tokens revoke --current

If a connection token has been exposed, you can revoke it so it can no longer be used. tokens current shows the current token ID without revealing its value. tokens revoke --current disables that token on the server. These commands are available in CLI 0.6.1 and later.

Revoking the token also ends any MCP sessions that use the same token. You will need a fresh connection code to connect again.

CLI

joripspace tokens revoke --token-id TOKEN_ID

For a token from an older connection, sign in with another valid token in the same account and replace TOKEN_ID with the ID you want to revoke. Check the ID carefully before running the command. You can also disable tokens on the API token page in your web profile. logout removes a local login; use token revocation when you need to stop access on the server.

View all docs Open projects