Skip to content
SignetSignetSignet Docs

Quickstart

This tutorial takes a local installation from zero to a working memory command. It uses the interactive setup route; use the reference pages when you need a managed or remote deployment.

1. Install Signet

Section titled “1. Install Signet”

On macOS or Linux, install the native binary:

Terminal window
curl -fsSL https://signetai.sh/install.sh | bash
signet --help

Windows users should install the package wrapper instead:

Terminal window
npm install -g signetai

See Install for package-manager alternatives and non-interactive setup.

2. Create a workspace

Section titled “2. Create a workspace”
Terminal window
signet setup

Setup starts Signet and opens guided dashboard onboarding: connect your agents and a model, optionally bring an Obsidian vault, transcript exports, or files, then save and recall a first memory. Provider processing starts only after your explicit connection test and enable action. See Set up Signet for the flow and recovery steps.

The default Minimal identity preset keeps normal startup context small. Setup creates AGENTS.md for that startup context and DREAMING.md for Dreaming sessions. Other presets create a different set of identity files; do not assume that every workspace has SOUL.md, USER.md, MEMORY.md, or a hooks directory. See Set up Signet for the preset and workspace details.

Setup initializes the database and starts a local daemon unless you selected a remote daemon. It can then open the dashboard.

3. Check the installation

Section titled “3. Check the installation”
Terminal window
signet status
signet dashboard

signet dashboard opens the local dashboard and starts the local daemon when necessary. If setup points the workspace at a remote daemon, the CLI uses that configured daemon URL instead.

4. Save and recall a memory

Section titled “4. Save and recall a memory”
Terminal window
signet remember "Use Bun for this project" --tags project,tooling
signet recall "Which package manager should this project use?"

Use --critical with signet remember to pin a memory. Recall combines the available keyword and embedding search paths; setup can run without embeddings if you prefer.

Next steps

Section titled “Next steps”