{
  "slug": "toolbar/quickstart",
  "title": "Toolbar Quickstart",
  "description": "Embed the Cuitty Toolbar in your app in under a minute.",
  "url": "https://cuitty.com/docs/toolbar/quickstart",
  "markdown_url": "https://cuitty.com/docs/toolbar/quickstart.md",
  "json_url": "https://cuitty.com/docs/toolbar/quickstart.json",
  "frontmatter": {
    "title": "Toolbar Quickstart",
    "description": "Embed the Cuitty Toolbar in your app in under a minute.",
    "order": 1,
    "section": "Toolbar",
    "updatedAt": "2026-05-31"
  },
  "headings": [
    {
      "depth": 1,
      "slug": "toolbar-quickstart",
      "text": "Toolbar Quickstart"
    },
    {
      "depth": 2,
      "slug": "script-tag-fastest",
      "text": "Script tag (fastest)"
    },
    {
      "depth": 2,
      "slug": "astro-integration",
      "text": "Astro integration"
    },
    {
      "depth": 2,
      "slug": "react-component",
      "text": "React component"
    },
    {
      "depth": 2,
      "slug": "what-youll-see",
      "text": "What you’ll see"
    },
    {
      "depth": 2,
      "slug": "configuration-basics",
      "text": "Configuration basics"
    },
    {
      "depth": 2,
      "slug": "whats-next",
      "text": "What’s next"
    }
  ],
  "body_markdown": "# Toolbar Quickstart\n\nThe Cuitty Toolbar is a floating dev-tools widget that embeds directly into your application. It gives your team instant access to logs, deploys, feature flags, secrets, and cost data without leaving the app. This guide covers three ways to add it.\n\n## Script tag (fastest)\n\nDrop a single script tag into your HTML `<head>`:\n\n```html\n<script\n  src=\"https://cdn.cuitty.com/toolbar/v1/toolbar.js\"\n  data-cuitty-project=\"your-project-id\"\n  data-cuitty-env=\"staging\"\n  defer\n></script>\n```\n\nReload the page. The toolbar launcher appears in the bottom-right corner. No build step required.\n\n## Astro integration\n\nInstall the integration:\n\n```bash\nnpm install @cuitty/toolbar-astro\n```\n\nAdd it to your Astro config:\n\n```ts\n// astro.config.mjs\nimport { defineConfig } from \"astro/config\";\nimport cuittyToolbar from \"@cuitty/toolbar-astro\";\n\nexport default defineConfig({\n  integrations: [\n    cuittyToolbar({\n      project: \"your-project-id\",\n      env: \"staging\",\n    }),\n  ],\n});\n```\n\nThe integration injects the toolbar script automatically in dev and preview modes. Pass `environments: [\"production\"]` to include it in production builds.\n\n## React component\n\nInstall the React package:\n\n```bash\nnpm install @cuitty/toolbar-react\n```\n\nRender the component at the root of your app:\n\n```tsx\nimport { CuittyToolbar } from \"@cuitty/toolbar-react\";\n\nexport default function App() {\n  return (\n    <>\n      <CuittyToolbar\n        project=\"your-project-id\"\n        env=\"staging\"\n      />\n      {/* rest of your app */}\n    </>\n  );\n}\n```\n\nThe component renders nothing visible in the DOM — it loads the toolbar script and initializes it with your configuration.\n\n## What you'll see\n\nOnce loaded, the toolbar shows a floating launcher with five icons:\n\n1. **Logs** — live tail of application logs filtered to the current page\n2. **Deploys** — recent deploy history with commit links and rollback buttons\n3. **Flags** — feature flag overrides scoped to your session\n4. **Secrets** — masked secret values with copy and rotation shortcuts\n5. **Costs** — real-time cost breakdown for the current project\n\nClick any icon to open its panel. The toolbar communicates with the Cuitty portal API using your project ID, so the portal must be reachable from the browser.\n\n## Configuration basics\n\nPass configuration as `data-` attributes (script tag) or props (component). The most common options:\n\n| Option      | Default         | Description                              |\n| ----------- | --------------- | ---------------------------------------- |\n| `project`   | —               | Your Cuitty project ID (required)        |\n| `env`       | `\"development\"` | Environment label shown in the toolbar   |\n| `position`  | `\"bottom-right\"`| Launcher position on screen              |\n| `modules`   | all             | Array of module names to enable           |\n| `theme`     | `\"auto\"`        | `\"light\"`, `\"dark\"`, or `\"auto\"`         |\n\n## What's next\n\n- [Toolbar features](/product/toolbar#features) — full list of modules, keyboard shortcuts, and customization options\n- [Toolbar product page](/product/toolbar) — architecture overview, demo, and SDK reference",
  "body_html": "<h1 id=\"toolbar-quickstart\">Toolbar Quickstart</h1>\n<p>The Cuitty Toolbar is a floating dev-tools widget that embeds directly into your application. It gives your team instant access to logs, deploys, feature flags, secrets, and cost data without leaving the app. This guide covers three ways to add it.</p>\n<h2 id=\"script-tag-fastest\">Script tag (fastest)</h2>\n<p>Drop a single script tag into your HTML <code>&#x3C;head></code>:</p>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"html\"><code><span class=\"line\"><span style=\"color:#E1E4E8\">&#x3C;</span><span style=\"color:#85E89D\">script</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">  src</span><span style=\"color:#E1E4E8\">=</span><span style=\"color:#9ECBFF\">\"https://cdn.cuitty.com/toolbar/v1/toolbar.js\"</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">  data-cuitty-project</span><span style=\"color:#E1E4E8\">=</span><span style=\"color:#9ECBFF\">\"your-project-id\"</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">  data-cuitty-env</span><span style=\"color:#E1E4E8\">=</span><span style=\"color:#9ECBFF\">\"staging\"</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">  defer</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">>&#x3C;/</span><span style=\"color:#85E89D\">script</span><span style=\"color:#E1E4E8\">></span></span></code></pre>\n<p>Reload the page. The toolbar launcher appears in the bottom-right corner. No build step required.</p>\n<h2 id=\"astro-integration\">Astro integration</h2>\n<p>Install the integration:</p>\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\">npm</span><span style=\"color:#9ECBFF\"> install</span><span style=\"color:#9ECBFF\"> @cuitty/toolbar-astro</span></span></code></pre>\n<p>Add it to your Astro config:</p>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"ts\"><code><span class=\"line\"><span style=\"color:#6A737D\">// astro.config.mjs</span></span>\n<span class=\"line\"><span style=\"color:#F97583\">import</span><span style=\"color:#E1E4E8\"> { defineConfig } </span><span style=\"color:#F97583\">from</span><span style=\"color:#9ECBFF\"> \"astro/config\"</span><span style=\"color:#E1E4E8\">;</span></span>\n<span class=\"line\"><span style=\"color:#F97583\">import</span><span style=\"color:#E1E4E8\"> cuittyToolbar </span><span style=\"color:#F97583\">from</span><span style=\"color:#9ECBFF\"> \"@cuitty/toolbar-astro\"</span><span style=\"color:#E1E4E8\">;</span></span>\n<span class=\"line\"></span>\n<span class=\"line\"><span style=\"color:#F97583\">export</span><span style=\"color:#F97583\"> default</span><span style=\"color:#B392F0\"> defineConfig</span><span style=\"color:#E1E4E8\">({</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">  integrations: [</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">    cuittyToolbar</span><span style=\"color:#E1E4E8\">({</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">      project: </span><span style=\"color:#9ECBFF\">\"your-project-id\"</span><span style=\"color:#E1E4E8\">,</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">      env: </span><span style=\"color:#9ECBFF\">\"staging\"</span><span style=\"color:#E1E4E8\">,</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">    }),</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">  ],</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">});</span></span></code></pre>\n<p>The integration injects the toolbar script automatically in dev and preview modes. Pass <code>environments: [\"production\"]</code> to include it in production builds.</p>\n<h2 id=\"react-component\">React component</h2>\n<p>Install the React package:</p>\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\">npm</span><span style=\"color:#9ECBFF\"> install</span><span style=\"color:#9ECBFF\"> @cuitty/toolbar-react</span></span></code></pre>\n<p>Render the component at the root of your app:</p>\n<pre class=\"astro-code github-dark\" style=\"background-color:#24292e;color:#e1e4e8; overflow-x: auto;\" tabindex=\"0\" data-language=\"tsx\"><code><span class=\"line\"><span style=\"color:#F97583\">import</span><span style=\"color:#E1E4E8\"> { CuittyToolbar } </span><span style=\"color:#F97583\">from</span><span style=\"color:#9ECBFF\"> \"@cuitty/toolbar-react\"</span><span style=\"color:#E1E4E8\">;</span></span>\n<span class=\"line\"></span>\n<span class=\"line\"><span style=\"color:#F97583\">export</span><span style=\"color:#F97583\"> default</span><span style=\"color:#F97583\"> function</span><span style=\"color:#B392F0\"> App</span><span style=\"color:#E1E4E8\">() {</span></span>\n<span class=\"line\"><span style=\"color:#F97583\">  return</span><span style=\"color:#E1E4E8\"> (</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">    &#x3C;></span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">      &#x3C;</span><span style=\"color:#79B8FF\">CuittyToolbar</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">        project</span><span style=\"color:#F97583\">=</span><span style=\"color:#9ECBFF\">\"your-project-id\"</span></span>\n<span class=\"line\"><span style=\"color:#B392F0\">        env</span><span style=\"color:#F97583\">=</span><span style=\"color:#9ECBFF\">\"staging\"</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">      /></span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">      {</span><span style=\"color:#6A737D\">/* rest of your app */</span><span style=\"color:#E1E4E8\">}</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">    &#x3C;/></span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">  );</span></span>\n<span class=\"line\"><span style=\"color:#E1E4E8\">}</span></span></code></pre>\n<p>The component renders nothing visible in the DOM — it loads the toolbar script and initializes it with your configuration.</p>\n<h2 id=\"what-youll-see\">What you’ll see</h2>\n<p>Once loaded, the toolbar shows a floating launcher with five icons:</p>\n<ol>\n<li><strong>Logs</strong> — live tail of application logs filtered to the current page</li>\n<li><strong>Deploys</strong> — recent deploy history with commit links and rollback buttons</li>\n<li><strong>Flags</strong> — feature flag overrides scoped to your session</li>\n<li><strong>Secrets</strong> — masked secret values with copy and rotation shortcuts</li>\n<li><strong>Costs</strong> — real-time cost breakdown for the current project</li>\n</ol>\n<p>Click any icon to open its panel. The toolbar communicates with the Cuitty portal API using your project ID, so the portal must be reachable from the browser.</p>\n<h2 id=\"configuration-basics\">Configuration basics</h2>\n<p>Pass configuration as <code>data-</code> attributes (script tag) or props (component). The most common options:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th>Option</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>project</code></td><td>—</td><td>Your Cuitty project ID (required)</td></tr><tr><td><code>env</code></td><td><code>\"development\"</code></td><td>Environment label shown in the toolbar</td></tr><tr><td><code>position</code></td><td><code>\"bottom-right\"</code></td><td>Launcher position on screen</td></tr><tr><td><code>modules</code></td><td>all</td><td>Array of module names to enable</td></tr><tr><td><code>theme</code></td><td><code>\"auto\"</code></td><td><code>\"light\"</code>, <code>\"dark\"</code>, or <code>\"auto\"</code></td></tr></tbody></table>\n<h2 id=\"whats-next\">What’s next</h2>\n<ul>\n<li><a href=\"/product/toolbar#features\">Toolbar features</a> — full list of modules, keyboard shortcuts, and customization options</li>\n<li><a href=\"/product/toolbar\">Toolbar product page</a> — architecture overview, demo, and SDK reference</li>\n</ul>",
  "links_out": [
    "/product/toolbar#features",
    "/product/toolbar"
  ]
}