{
  "slug": "reference/cli",
  "title": "CLI reference",
  "description": "The cui binary — operate Cuitty installs from the terminal.",
  "url": "https://cuitty.com/docs/reference/cli",
  "markdown_url": "https://cuitty.com/docs/reference/cli.md",
  "json_url": "https://cuitty.com/docs/reference/cli.json",
  "frontmatter": {
    "title": "CLI reference",
    "description": "The cui binary — operate Cuitty installs from the terminal.",
    "order": 3,
    "section": "Reference",
    "updatedAt": "2026-04-27"
  },
  "headings": [
    {
      "depth": 1,
      "slug": "cli-reference",
      "text": "CLI reference"
    },
    {
      "depth": 2,
      "slug": "install",
      "text": "Install"
    },
    {
      "depth": 2,
      "slug": "auth",
      "text": "Auth"
    },
    {
      "depth": 2,
      "slug": "projects",
      "text": "Projects"
    },
    {
      "depth": 2,
      "slug": "modules",
      "text": "Modules"
    },
    {
      "depth": 2,
      "slug": "send-a-one-off-event",
      "text": "Send a one-off event"
    },
    {
      "depth": 2,
      "slug": "self-hosted-operator-commands",
      "text": "Self-hosted operator commands"
    }
  ],
  "body_markdown": "# CLI reference\n\n`cui` is the official command-line companion. It wraps the REST API for everyday operator tasks.\n\n## Install\n\n```bash\ncurl -fsSL https://releases.cuitty.com/cli/install.sh | sh\n```\n\n## Auth\n\n```bash\ncui login --portal https://app.cuitty.com\ncui logout\ncui whoami\n```\n\n## Projects\n\n```bash\ncui project list\ncui project create <name>\ncui project use <id>\ncui project keys create\n```\n\n## Modules\n\n```bash\ncui audit list --project <id> --since 24h\ncui logs tail --project <id> --service api\ncui deploys list --env production\ncui costs report --period 2026-04\n```\n\n## Send a one-off event\n\n```bash\ncui send audit \\\n  --actor alice@example.com \\\n  --action secret.rotate \\\n  --resource stripe.live_key\n```\n\n## Self-hosted operator commands\n\n```bash\ncui admin migrate           # Run pending migrations\ncui admin backup            # Snapshot Postgres + libSQL\ncui admin verify-chain      # Verify the audit-chain integrity\n```",
  "body_html": "<h1 id=\"cli-reference\">CLI reference</h1>\n<p><code>cui</code> is the official command-line companion. It wraps the REST API for everyday operator tasks.</p>\n<h2 id=\"install\">Install</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">curl</span><span style=\"color:#79B8FF\"> -fsSL</span><span style=\"color:#9ECBFF\"> https://releases.cuitty.com/cli/install.sh</span><span style=\"color:#F97583\"> |</span><span style=\"color:#B392F0\"> sh</span></span></code></pre>\n<h2 id=\"auth\">Auth</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> login</span><span style=\"color:#79B8FF\"> --portal</span><span style=\"color:#9ECBFF\"> https://app.cuitty.com</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> logout</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> whoami</span></span></code></pre>\n<h2 id=\"projects\">Projects</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> project</span><span style=\"color:#9ECBFF\"> list</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> project</span><span style=\"color:#9ECBFF\"> create</span><span style=\"color:#F97583\"> &#x3C;</span><span style=\"color:#9ECBFF\">nam</span><span style=\"color:#E1E4E8\">e</span><span style=\"color:#F97583\">></span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> project</span><span style=\"color:#9ECBFF\"> use</span><span style=\"color:#F97583\"> &#x3C;</span><span style=\"color:#9ECBFF\">i</span><span style=\"color:#E1E4E8\">d</span><span style=\"color:#F97583\">></span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> project</span><span style=\"color:#9ECBFF\"> keys</span><span style=\"color:#9ECBFF\"> create</span></span></code></pre>\n<h2 id=\"modules\">Modules</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> audit</span><span style=\"color:#9ECBFF\"> list</span><span style=\"color:#79B8FF\"> --project</span><span style=\"color:#F97583\"> &#x3C;</span><span style=\"color:#9ECBFF\">i</span><span style=\"color:#E1E4E8\">d</span><span style=\"color:#F97583\">></span><span style=\"color:#79B8FF\"> --since</span><span style=\"color:#9ECBFF\"> 24h</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> logs</span><span style=\"color:#9ECBFF\"> tail</span><span style=\"color:#79B8FF\"> --project</span><span style=\"color:#F97583\"> &#x3C;</span><span style=\"color:#9ECBFF\">i</span><span style=\"color:#E1E4E8\">d</span><span style=\"color:#F97583\">></span><span style=\"color:#79B8FF\"> --service</span><span style=\"color:#9ECBFF\"> api</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> deploys</span><span style=\"color:#9ECBFF\"> list</span><span style=\"color:#79B8FF\"> --env</span><span style=\"color:#9ECBFF\"> production</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> costs</span><span style=\"color:#9ECBFF\"> report</span><span style=\"color:#79B8FF\"> --period</span><span style=\"color:#9ECBFF\"> 2026-04</span></span></code></pre>\n<h2 id=\"send-a-one-off-event\">Send a one-off event</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> send</span><span style=\"color:#9ECBFF\"> audit</span><span style=\"color:#79B8FF\"> \\</span></span>\n<span class=\"line\"><span style=\"color:#79B8FF\">  --actor</span><span style=\"color:#9ECBFF\"> alice@example.com</span><span style=\"color:#79B8FF\"> \\</span></span>\n<span class=\"line\"><span style=\"color:#79B8FF\">  --action</span><span style=\"color:#9ECBFF\"> secret.rotate</span><span style=\"color:#79B8FF\"> \\</span></span>\n<span class=\"line\"><span style=\"color:#79B8FF\">  --resource</span><span style=\"color:#9ECBFF\"> stripe.live_key</span></span></code></pre>\n<h2 id=\"self-hosted-operator-commands\">Self-hosted operator commands</h2>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"bash\"><code><span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> admin</span><span style=\"color:#9ECBFF\"> migrate</span><span style=\"color:#6A737D\">           # Run pending migrations</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> admin</span><span style=\"color:#9ECBFF\"> backup</span><span style=\"color:#6A737D\">            # Snapshot Postgres + libSQL</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">cui</span><span style=\"color:#9ECBFF\"> admin</span><span style=\"color:#9ECBFF\"> verify-chain</span><span style=\"color:#6A737D\">      # Verify the audit-chain integrity</span></span></code></pre>",
  "links_out": []
}