Menu

create-snipara

One-command onboarding and maintenance for Snipara Hosted MCP Context + Memory. Run it once, choose your assistant, and Snipara generates the Hosted MCP config, rules, templates, checks, and workflow helpers that assistant needs. Existing root instruction files stay in place; fresh copies are kept under .snipara/templates for merge review. Advanced production orchestration remains opt-in. Install once with create-snipara; continue every session with snipara-companion.

Primary path
Onboarding package for Hosted MCP
Use create-snipara when the user wants the lowest-friction path to connect Claude Code, Codex, Cursor, VS Code, Gemini CLI, Mistral, ChatGPT Desktop, or another MCP client to Snipara Context + Memory.

Use This When

create-snipara is useful when you want browser account onboarding, API key capture, generated config, doctor reports, GitHub repo automation, and optional snipara-sandbox.

If the user already has an account, reuse their API key. If not, choose the free signup path: the account includes Context Free and reviewed Memory Free.

What create-snipara is not for

Do not use create-snipara to manually select non-code source folders one by one. Keep the product boundary simple:

  • create-snipara: account, auth, Hosted MCP config, GitHub repo setup
  • Helvabase: RFPs, client dossiers, proposal workflows, and reviewed business sources
  • Hosted MCP: the agent tool surface the LLM uses after setup
npx create-snipara

What It Does

  • Handles auth onboarding — Reuse an existing API key, run browser device authorization for free Context + Memory, or leave a placeholder for later
  • Writes hosted MCP config — Project-scoped configuration for supported MCP clients
  • Installs optional snipara-companion — Git-style local continuity for status, briefs, timelines, phase commits, handoffs, resume, query, code impact, and task workflows
  • Installs snipara-sandbox — Safe code execution with Docker isolation
  • Can install snipara-orchestrator — Optional production gates, drift checks, and htask orchestration when requested with --with-orchestrator
  • Configures hosted MCP — Client-specific HTTP MCP references for the selected assistant
  • Generates AI agent templates — Merge-ready AGENTS.md, CLAUDE.md, .cursor/rules/snipara.mdc, .codex/config.toml, Mistral Vibe/Le Chat/LangChain snippets, and ChatGPT/OpenAI MCP snippets
  • Preserves existing instructions — Existing AGENTS.md and CLAUDE.md files are extended with a marked Snipara section instead of being overwritten
  • Opens GitHub automation — Detects owner/repo, preserves branch/path defaults, and opens the Snipara GitHub App setup when requested
  • Sets up hooks when supported — Claude Code, Codex, Cursor, Gemini CLI, and legacy Windsurf bundles are generated only when the selected client has a compatible local hook surface
  • Updates environment files — Adds project and auth configuration
  • Adds maintenance commandsdoctor, repair, upgrade, and print-config
What create-snipara generates

This matrix is derived from the shared Snipara compatibility contract. It keeps docs, dashboard states, and generated automation bundles aligned around the configured agent.

AgentGenerated by create-sniparaHook install statusCaveat
Claude Code
Hosted MCP, project instructions, and verified lifecycle hooks.
AGENTS.md, CLAUDE.md, .mcp.json, .claude/settings.json, .claude/hooks/*.shSupported nowClaude Code is the verified full-hook baseline for Snipara automation.
OpenAI Codex
Hosted MCP, AGENTS.md, Codex config, and native hook automation.
AGENTS.md, .codex/config.toml, .codex/hooks.json, .codex/hooks/*.shSupported nowCodex documents native hooks and Snipara ships a bundle for supported lifecycle events; compaction-specific hooks remain unavailable.
Cursor
Hosted MCP, project rules, and native hook automation.
AGENTS.md, .cursor/mcp.json, .cursor/rules/snipara.mdc, .cursor/hooks.json, .cursor/hooks/*.shSupported nowCursor documents project hooks and Snipara ships a bundle for supported lifecycle events; blocking/enforce decisions remain adapter-limited.
VS Code / Copilot
Hosted MCP and Copilot instructions; hook support is preview-gated.
.vscode/mcp.json, .github/copilot-instructions.mdPreview gatedVS Code agent hooks are preview and can be organization-disabled; Snipara does not install them by default.
Gemini CLI
Hosted MCP, GEMINI.md, and native hook automation.
GEMINI.md, .gemini/settings.json, .gemini/hooks/*.shSupported nowGemini CLI documents native hooks and Snipara ships a supported bundle; review scripts and enable only in trusted repositories.
Mistral Le Chat / Vibe
Hosted MCP for Le Chat and Vibe plus ChatMistralAI tool calling templates.
AGENTS.md, MISTRAL.md, .vibe/config.toml, mistral-le-chat-mcp.json, mistral-langchain-tools.tsMCP onlyMistral request hooks wrap model HTTP requests; they are not local agent lifecycle hooks, so Snipara installs MCP and instruction files only.
MCP-only / Custom
Hosted MCP tools and explicit commands only.
mcp-config.jsonMCP onlyMCP standardizes tools, resources, and prompts, not universal host lifecycle hooks.

Hook Selection Model

Hooks are selected in Snipara project automation settings, not through a separate per-client installer. Local materialization uses the companion command surface:

npx -y snipara-companion@latest automations install --client claude-code
npx -y snipara-companion@latest automations diff
npx -y snipara-companion@latest automations update
npx -y snipara-companion@latest automations status

Unsupported or preview-gated hook bundles remain disabled by default. Hosted MCP and generated instructions still work for every MCP-compatible client.

Install Profiles

ProfileWhat it installsBest for
hosted-companionHosted MCP + snipara-companionDefault: hosted context plus managed local workflows
hosted-onlyHosted MCP config onlyLocked-down or minimal environments
full-stackHosted MCP + snipara-companion + snipara-sandboxHosted context plus local execution. Orchestrator is not included unless --with-orchestrator is passed.
runtime-onlysnipara-sandbox onlyPure local execution without hosted API

Hosted Core + Snipara Sandbox Edge

create-snipara installs a hosted-first setup. Snipara stays the source of truth for memory, review, policy, and orchestration. The local install only adds a Snipara Sandbox edge layer for hook capture, context restore, optional safe execution, and explicit production orchestration when requested.

  • Hosted core: 125-tool MCP surface, reviewed memory, orchestration, automation policies
  • Snipara Sandbox edge: local hooks, compatibility CLI flows, and optional snipara-sandbox
  • Optional orchestrator: snipara-orchestrator is installed only for production validation, proof gates, drift checks, or htask coordination.
  • Companion workflows: snipara-companion query, status, brief, timeline, handoff, plan, multi-query, orchestrate, load-document, upload, onboard-folder, chunk, events recent, session-bootstrap, task-commit, and managed workflow commands
  • Generated companion pack: .snipara/companion with client-aware command presets, local usage guidance, and a doctor report
  • GitHub code path: source repositories go through the GitHub App flow, which creates or reuses the repository project and enables push sync
  • Design rule: local adapters capture and forward signals; they do not own durable memory policy

Interactive Setup

Run npx create-sniparain your project directory. You'll be prompted for:

The default flow uses the recommended hosted-companion profile. Use --advanced when you want profile selection, project IDs, hooks, GitHub prompts, orchestrator opt-in, or Snipara Sandbox provider prompts. Use --profile hosted-only or --skip-companion for minimal locked-down installs. Use --with-orchestrator only when you want the advanced production validation package.

After install: continue the work

create-snipara gets the project connected. snipara-companion becomes the day-two command surface for agents that need status, briefs, timelines, phase commits, handoffs, and resume points.

snipara-companion status
snipara-companion brief --task "ship auth hardening"
snipara-companion workflow phase-commit build --summary "tests green"
snipara-companion handoff --summary "ready for release checks"
snipara-companion workflow resume --include-session-context
PromptDescription
Project slugAuto-detected from git remote or directory name
Project ID (advanced)Optional, for advanced use cases
Snipara auth pathExisting API key, free Context + Memory signup flow, or skip Snipara auth for Snipara Sandbox only
API keyYour Snipara API key when you choose the manual key-based path
AI clientClaude Code, Codex, Cursor, VS Code, Gemini CLI, Mistral, ChatGPT, or custom MCP
Install profile (advanced)Hosted only, hosted + companion, full stack, or Snipara Sandbox only
Orchestrator (advanced or --with-orchestrator)Optional snipara-orchestrator install for proof-based production validation, drift checks, and htask workflows
Hooks (advanced)Whether compatible local hooks should be generated when supported
GitHub automation (advanced or --github)When a GitHub remote is detected, whether to open the Snipara GitHub App setup with repo and branch already carried through
LLM provider (Snipara Sandbox profiles)OpenAI, Anthropic, or None (for snipara-sandbox run/snipara-sandbox agent CLI)
Run snipara-sandbox init (Snipara Sandbox profiles)Optional — configure execution environment (sandbox/docker/local)

Browser Approval

create-snipara uses the terminal for local setup and the browser for identity or source approval.

  • The terminal writes config, doctor reports, hooks, and local project wiring.
  • The browser handles Snipara login and GitHub approval.
  • GitHub approval stays in the browser because the user must explicitly choose which account, organization, and repositories Snipara can read.

That keeps repository sync explicit and revocable. The Hosted MCP server is for agent usage after setup, not for the initial source-permission choice.

Choose Sources

GitHub repository

Use npx create-snipara --github when the current folder is a GitHub repo. The CLI detects the repo and opens the Snipara GitHub App flow with repo, branch, and optional path filter already carried through.

Business workflows

Use Helvabase when the user wants to work from local folders, mounted Drive or SharePoint exports, old offers, PowerPoints, templates, or RFP files. Snipara stays focused on agent setup, repository context, and Hosted MCP.

Maintenance Commands

doctor

Validates local wiring and writes .snipara/companion/doctor.json.

repair

Rebuilds local configuration, companion pack, hooks, and optional add-ons such as Sandbox or Orchestrator when requested.

upgrade

Upgrades installed local pieces and refreshes generated assets.

print-config

Shows the inferred local setup and install profile.

npx create-snipara doctor
npx create-snipara repair
npx create-snipara repair --with-orchestrator

Execution Environments

When you select Snipara Sandbox during setup, you'll be asked if you want to run snipara-sandbox init to configure the execution environment:

EnvironmentDescriptionUse Case
sandboxRestrictedPython, safe stdlib onlyDefault, most secure
dockerFull Python in isolated containerRecommended for full features
localFull access, no isolationDevelopment only

Security Recommendation

Use docker mode for production and untrusted code. local mode is only recommended for development and AI-generated code.

You can also configure the environment later by running snipara-sandbox init manually.

API Key Requirements

Positioning Note

This page documents the automated installer and its manual key-based options.

Snipara itself is not API-key-only. Hosted MCP remains the primary agent path. Use local snipara-mcp login only for stdio compatibility, client development, or advanced testing.

ToolSnipara API KeyLLM API Key (OpenAI/Anthropic)
execute_python MCPNot neededNot needed (your AI client is the LLM)
snipara_context_query MCPRequiredNot needed
snipara_remember/snipara_recallRequiredNot needed
snipara-sandbox run / snipara-sandbox agent CLIOptional (for context)Required

API Keys

TypeDescription
Existing API keyUse with --api-key; expected prefix is snp-, with legacy rlm_ keys still accepted
Browser signup keyAuto-provisioned by Snipara through the browser flow; returned prefix is snp-

Command Line Options

Basic usage
npx create-snipara
With existing API key
npx create-snipara --api-key snp-your-key
Specify project slug
npx create-snipara --slug my-project
Advanced prompts for profiles, hooks, GitHub, and Snipara Sandbox
npx create-snipara --advanced
Snipara Sandbox only - no Snipara API key needed
npx create-snipara --runtime-only
Open GitHub automation for the detected repo
npx create-snipara --github
npx create-snipara --github-path docs/
Skip local companion CLI
npx create-snipara --skip-companion
Skip specific installations
npx create-snipara --skip-mcp # Skip local snipara-mcp package
npx create-snipara --skip-runtime # Skip snipara-sandbox
npx create-snipara --skip-hooks # Skip local hooks
npx create-snipara --skip-test # Skip connection test
npx create-snipara --skip-github # Skip GitHub automation prompt
Accept all defaults (non-interactive)
npx create-snipara -y --api-key snp-xxx --slug my-project

What Gets Created

.mcp.json

{
  "mcpServers": {
    "snipara": {
      "type": "http",
      "url": "https://api.snipara.com/mcp/your-project",
      "headers": {
        "X-API-Key": "snp-your-key"
      }
    },
    "snipara-sandbox": {
      "type": "http",
      "url": "http://localhost:8765/mcp",
      "headers": {}
    }
  }
}

Claude Code Hooks (if selected)

  • snipara-startup.sh - Restores session context
  • snipara-session.sh — Auto-remembers commits
  • snipara-compact.sh — Saves context before compaction

Local Companion Pack

create-snipara also generates a small project-local starter pack under .snipara/companion. The default hosted-companion mode uses it for managed workflow commands; hosted-only keeps the same pack as an upgrade path.

  • README.md - client-aware usage guidance and starter commands
  • commands.json - machine-readable command presets for local workflows

Companion Workflows

The companion CLI is a thin local facade over hosted Snipara workflows. It is useful when you want repeatable local commands in addition to MCP access.

Operating Rule

Use context commands first for source truth (query, shared-context, load-document). Use memory commands second for durable state (session-bootstrap, task-commit).

snipara-companion query --query "how does auth middleware work?"
snipara-companion shared-context --categories MANDATORY BEST_PRACTICES
snipara-companion plan --query "implement webhook retry hardening"
snipara-companion multi-query --queries "recent incidents" "rate limit headers"
snipara-companion orchestrate --query "map auth architecture"
snipara-companion load-document --path docs/architecture/auth.md
snipara-companion recall --query "What did we decide about auth retries?" --type decision
snipara-companion events recent --limit 20
snipara-companion session-bootstrap --include-session-context --max-context-tokens 1000
snipara-companion task-commit --summary "Shipped retry hardening"

These commands print human-readable output by default. Add --json when you need the raw hosted response.

Environment Files

Updates .env.example and .env.local with:

Snipara Configuration
SNIPARA_API_KEY=your_api_key
SNIPARA_PROJECT_SLUG=your-project
Snipara Sandbox LLM Provider (if configured)
OPENAI_API_KEY=sk-...
or
ANTHROPIC_API_KEY=sk-ant-...

After Installation

For Claude Code / Cursor

  1. Claude Code loads MCP from the generated project .mcp.json; .claude/settings.json is used only when hooks are enabled. Cursor uses the generated project MCP config and rule files.
  2. Restart your AI client or open a new agent session.
  3. Confirm Snipara appears in MCP settings or ToolSearch. If not, run npx create-snipara doctor --client claude-code.

For Claude Desktop

  1. Restart Claude Desktop
  2. Config is at ~/Library/Application Support/Claude/claude_desktop_config.json

Business Folder Onboarding

For dashboardless business-context imports, let Claude, ChatGPT, Codex, or another LLM client use its own Drive, Gmail, Notion, or local-file access to materialize a folder, then use snipara-companion to preview and apply the import.

snipara-companion onboard-folder ./client-export --source-provider local_folder --write-manifest ./snipara-onboard.json
snipara-companion onboard-folder ./client-export --source-provider local_folder --apply

onboard-folder classifies folders as business, code, mixed, or unknown, but it is business-first. If it detects a source-code repository, use the GitHub OAuth/code onboarding path instead.

GitHub Repository Automation

When create-snipara detects a GitHub remote, it can open the Snipara GitHub App flow with owner/repo, branch, and optional path filter already carried through. The browser flow installs or updates the GitHub App, lets the user connect the detected repository, creates or reuses the matching Snipara project, enables push sync, and starts the first documentation sync.

npx create-snipara --github
npx create-snipara --github-path docs/

If you intentionally started with hosted-only, enable companion before using business-folder imports:

npx create-snipara repair --with-companion

Snipara Sandbox Usage

MCP Tools (no LLM API key needed):

Your AI client (Claude, GPT, etc.) provides the LLM — no additional API key required.

ToolDescription
execute_pythonRun Python in sandbox
get_repl_contextGet session variables
set_repl_contextSet session variables
clear_repl_contextClear session

CLI Commands (requires LLM API key):

For snipara-sandbox run and snipara-sandbox agent, you need an LLM provider API key:

Set your LLM provider
export OPENAI_API_KEY=sk-...
or
export ANTHROPIC_API_KEY=sk-ant-...
Run commands
snipara-sandbox init # Initialize configuration
snipara-sandbox run --env docker # Run with Docker isolation
snipara-sandbox agent "task" # Autonomous agent mode
snipara-sandbox visualize # Launch trajectory dashboard

Available MCP Tools

If you enable hook-compatible local tooling, the install can also forward canonical lifecycle events into Snipara's automation API. That lets local adapters feel closer to a local-memory workflow while keeping review and persistence centralized.

After setup, you have access to the current 125-tool MCP contract across context, memory, automation, analytics, and orchestration:

CategoryTools
Contextsnipara_context_query, snipara_ask, snipara_search, snipara_sections
Planningsnipara_plan, snipara_decompose, snipara_multi_query
Memorysnipara_remember, snipara_recall, snipara_memories, snipara_forget, snipara_memory_attach_source, snipara_memory_verify, snipara_memory_invalidate, snipara_memory_supersede, snipara_memory_review_queue, snipara_memory_resolve_queue_item
Executionexecute_python, get_repl_context (via Snipara Sandbox)
Swarmssnipara_swarm_create, snipara_claim, snipara_task_create

Requirements

  • Node.js 18+
  • Python 3.10+ (for snipara-mcp and snipara-sandbox)
  • Docker (optional, for Snipara Sandbox isolation)

Links

Next Steps