RootCX
Docs
Pricing
RootCX/RootCXSource Available
Introduction
What is RootCX?Getting StartedHow it Works
Build
ApplicationAI AgentIntegrationDeploying
Platform
CoreAuthenticationRBACData APISecret VaultJob QueueAudit LogReal-time LogsChannels
Developers
React SDKBackend & RPCManifest ReferenceREST APICLIClaude CodeSelf-Hosting
DocsDevelopersCLI

CLI

The rootcx CLI is an alternative to RootCX Studio for developers who prefer working from the terminal. It connects to a Core instance, scaffolds projects, deploys apps and agents, and invokes agents from the command line.

Installation

The CLI is distributed as part of the RootCX toolchain. Download it from the GitHub releases.

Commands

rootcx connect

Connect the current workspace to a RootCX Core instance.

rootcx connect https://myproject.rootcx.com

The CLI detects the Core's auth mode and prompts for credentials if needed (password login or OIDC browser flow). Connection details are saved to .rootcx/config.json in the current directory.

Use --token to provide an existing access token directly:

rootcx connect https://myproject.rootcx.com --token eyJ...

rootcx new

Scaffold a new project. Creates a Vite + React + Tailwind project with the RootCX SDK pre-configured.

rootcx new app my_crm
rootcx new agent support_agent

Two kinds: app (standard application) or agent (AI agent with agent.json and system prompt).

rootcx deploy

Deploy the current project to the connected Core.

rootcx deploy

The deploy process:

  1. Reads manifest.json from the current directory.
  2. Installs the manifest via POST /api/v1/apps.
  3. Packs and uploads backend/ as a tar.gz archive (if present).
  4. Packs and uploads dist/ as a tar.gz archive (if present).
  5. Starts the worker if a backend was deployed.

rootcx apps

List all installed apps on the connected Core.

rootcx apps

rootcx uninstall

Uninstall an app. Removes the app, its secrets, jobs, and filesystem data.

rootcx uninstall my_crm

rootcx invoke

Invoke an AI agent and stream its response.

rootcx invoke support_agent "What are the open tickets?"

Use --session to resume an existing session:

rootcx invoke support_agent "And the closed ones?" --session abc123

rootcx status

Check the connection to the Core and display its status.

rootcx status

rootcx logout

Clear stored credentials from .rootcx/config.json.

rootcx logout

rootcx skills-path

Print the path to the bundled skills directory. Used internally by the Claude Code plugin.

rootcx skills-path
PreviousREST APINextClaude Code

On this page

Installation
Commands