Docs/Getting Started

Getting Started

Sign in, choose your infrastructure tier, and start using NOME in minutes.

Account creation and sign-in

NOME supports multiple entry paths. Use WorkOS-backed sign-in for enterprise accounts with SSO, Google sign-in for personal accounts, or continue as a guest for immediate local-first access.

After authentication, the canonical /v1/me/bootstrap endpoint resolves your plan, entitlements, org context, marketplace state, and surface policy. Every client — web, native, and CLI — consumes this same bootstrap payload.

Guest mode and anonymous sessions

Guest mode gives you a temporary session with local-first workflows. No account is required. Memory, threads, and workspace state are available for the duration of the session.

When you're ready for durable history, cross-device sync, org tools, or more hosted credits, sign in to upgrade your guest session into a full account.

BYOK key configuration

Bring Your Own Keys mode lets you connect API keys from Anthropic, OpenAI, DeepSeek, Gemini, MiniMax, and Google Vertex directly. NOME provides the interface, memory kernel, agentic flows, and routing logic while you pay providers directly.

Configure keys through the account surface at /keys or via the native app settings. NOME validates each key on entry and shows real-time provider status.

NOME Cloud subscription setup

NOME Cloud is the managed infrastructure tier. Subscribe and receive NOME Credits — we handle API negotiations, rate limiting, provider failover, and billing. One subscription covers all models.

Plans are managed through the canonical billing surface. Stripe handles the payment rail, but NOME owns the canonical subscription state, entitlement projection, and credit metering.

Bootstrap and session lifecycle

Every NOME session begins with bootstrap. The platform resolves your identity, org membership, plan, entitlements, installed surfaces, and active continuity state into a single payload.

Sessions are backed by Nome-issued tokens that carry org context and surface access claims. WorkOS enterprise sessions exchange into the same canonical Nome session, ensuring consistent authorization across all entry paths.

Connecting your first workspace

Workspaces bind to projects and repositories. NOME's Code/Workspace surface provides repo-aware coding with guardrails, sandbox isolation, and full audit trails.

Connect a workspace through the web app, native app, or CLI. The harness contract ensures every workspace operation — file edits, test runs, and commits — produces typed receipts attached to canonical work items.

Ready to try it?

Open NOME