Skip to main content

​
Authentication

Before using xCommand, you need to authenticate. You can trigger the login process by pressing L when the CLI is running in interactive mode.
To run xCommand in server mode, you will need xCommand API Token as XCOMMAND_API_KEY environment variable. You can get it from your xCommand.ai/platform once logged in.

​
Basic Usage

Run the CLI in interactive mode: 
xcommand
To run xCommand in server mode defaults to port 8080: 
xcommand server
For custom port: 
xcommand server --port 9000

​
CLI Features

Once logged in, you can interact with the xCommand directly from your terminal.

​
Slash Commands

While in the interactive chat, you can use slash commands to perform specific actions:
  • /knowledge: Manage your knowledge base.
    • /knowledge list: List installed modules.
    • /knowledge search [query]: Search for modules.
    • /knowledge add <name>: Install a module.
    • /knowledge delete <name>: Remove a module.
  • /plugin: Manage your plugins.
    • /plugin list: List installed plugins.
    • /plugin search [query]: Search for plugins.
    • /plugin add <name>: Install a plugin.
    • /plugin delete <name>: Remove a plugin.
  • /insights: View session and token usage insights.
  • /docs: View documentation.
  • /platform: View platform to manage xCommand account.
  • /logout: Sign out of your account.
  • /clear: Clear the chat history.
  • /help: Show the help screen.

​
Shell Mode

You can run local shell commands directly from the xCommand interface by prefixing them with a backslash (\): 
\ls -la

\cd

​
Session Management

When you exit a session, xCommand saves it. You can rejoin a saved session by running: 
xcommand [session-id]

​
Update xCommand

To update xCommand to the latest version, run: 
xcommand update