Getting Started

Quick Start

1. Download Entrance

   Grab the latest release for your platform:

   Windows

   Download the latest .zip from Releases, extract it, and run entrance.exe.

   Build from Source

   git clone https://github.com/myteapot/Entrance.git
   cd Entrance
   pnpm install --frozen-lockfile && pnpm build
   cargo build --manifest-path src-tauri/Cargo.toml --release

2. Verify installation

   .\entrance.exe nota status
   # → token_count: 0, mcp_config_count: 0

3. Connect your AI agent via MCP

   MCP (stdio)

   # For Codex CLI, Claude Code, or any MCP-compatible agent
   .\entrance.exe mcp stdio

   HTTP API

   # For scripts, CI/CD, or custom integrations
   .\entrance.exe mcp http --port 9720

4. Store your first API key

   Open the Vault UI or use the CLI to securely store an API token. Your agent can now fetch it on demand.

5. Dispatch your first task

   .\entrance.exe nota do --title "Fix login page 500 error"
   .\entrance.exe nota overview

What’s Next?

• Learn about the Plugin Architecture
• Understand the Architecture design
• Explore the CLI Reference