Skip to content
gunsole

Quick Start

import { Steps, Aside } from ‘@astrojs/starlight/components’;

  1. Start the desktop app

    Build from source or download a pre-built binary (when available). The app starts a local server on localhost:17655 automatically.

  2. Install the SDK

    Terminal window
    pnpm add gunsole-js

  3. Send your first log

    import { createGunsoleClient } from "gunsole-js";
    

    const gun = createGunsoleClient({
      projectId: "my-app",
      apiKey: "dev",
      mode: "local",
    });
    

    gun.info({
      bucket: "general",
      message: "hello from gunsole",
    });

  4. See it in the app

    Open the Gunsole desktop app. Your project my-app appears in the sidebar. Click it. Your log is there.

That’s the whole flow. Everything after this is just making it more useful.

What just happened

Section titled “What just happened”

The SDK created a log entry with level info, put it in the general bucket under the my-app project, and sent it (batched, gzip-compressed) to localhost:17655. The desktop app received it, stored it in SQLite, and emitted it to the UI in real-time.

The projectId identifies your app. The bucket is a category within that project — think of it like a label or namespace. Both are auto-created on first use. No configuration needed.

Next steps

Section titled “Next steps”