> ## Documentation Index
> Fetch the complete documentation index at: https://xanots.docs.xano.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Your Xano backend, as TypeScript you own

> XanoTS authors your whole Xano workspace (database, APIs, functions, triggers, realtime, AI agents) as typed TypeScript in your repo, then ships it live with one command.

Xano gives you a genuinely scalable backend (Postgres, serverless functions, background
tasks, realtime, MCP servers, AI agents) without you running a single server. **XanoTS** is
Xano's officially supported TypeScript SDK, and it gives you that backend **as code you
own**: version it, review it in PRs, diff it, roll it back.

```bash theme={null}
npx @xanots/sdk login                      # 1. sign in (opens your browser)
npx @xanots/sdk init my-app && cd my-app   # 2. scaffold your backend + frontend
npm run build                              # 3. build your frontend → frontend/dist
npx xanots deploy ./xano/index.ts --static ./frontend/dist   # 4. deploy both → live URLs
```

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/guides/quickstart" horizontal>
    Empty folder to a live full-stack app, in four commands.
  </Card>

  <Card title="Start here" icon="compass" href="/guides/start-here" horizontal>
    New, joining a team, or migrating a workspace? The path for your situation.
  </Card>

  <Card title="The model" icon="cube" href="/guides/the-model" horizontal>
    Def objects, one workspace, one importable bundle.
  </Card>

  <Card title="Glossary" icon="book" href="/guides/glossary" horizontal>
    Instance, workspace, branch, ephemeral, bundle, guid, and what each actually means.
  </Card>
</CardGroup>

## Why XanoTS

<Columns cols={2}>
  <Card title="TypeScript is the source of truth" icon="file-code">
    Tables, indexes, endpoints, functions, triggers, tasks, middleware, AI toolsets: all
    typed TS in your repo. No clicking through a dashboard and hoping prod matches staging.
  </Card>

  <Card title="Deploy is built in" icon="cloud-arrow-up">
    `xanots deploy` compiles your code, ships it over an authenticated connection, and
    prints the URL. Backend **and** static frontend in one command.
  </Card>

  <Card title="Fast, safe iteration" icon="bolt">
    Ephemeral environments are disposable and auto-expiring. Deploys are identity-stable:
    re-running never duplicates objects, and with a committed `xano.lock` renames stay renames.
  </Card>

  <Card title="Types flow to your frontend" icon="arrow-right-arrow-left">
    Import a `query()` def into your React/Svelte/Angular app and get the path, verb, and a
    fully-typed payload, with zero codegen.
  </Card>
</Columns>

<Tip>
  **AI-first by design.** A deterministic, fully-typed authoring surface means an agent (or
  you) emits well-typed TS that always compiles to a valid, importable workspace. It ships
  with machine-readable grounding an agent reads instead of your source. See
  [Coverage & agent grounding](/reference/coverage).
</Tip>

## Start here

<CardGroup cols={2}>
  <Card title="The scaffolded project" icon="folder-tree" href="/guides/scaffold">
    What `xanots init` writes: the two frontend presets, theming, and add-ons.
  </Card>

  <Card title="Object kinds" icon="shapes" href="/guides/object-kinds">
    Every authorable primitive, and splitting a workspace across microservices.
  </Card>

  <Card title="Authoring reference" icon="pen-ruler" href="/guides/authoring">
    Tables and fields, statements, values, inputs, middleware, request history.
  </Card>

  <Card title="Signing in & deploying" icon="rocket" href="/guides/deploying">
    Auth, ephemerals, `--static`, releasing to production, and `xanots preflight`.
  </Card>

  <Card title="Development workflows" icon="code-branch" href="/guides/development-workflows">
    Solo, team, automated, and builder-led flows, plus the one choice that decides the rest.
  </Card>

  <Card title="Git, locks & merges" icon="code-merge" href="/guides/git-and-merges">
    New to git? Start here. Plus `xano.lock` conflicts, renames, and the PR review checklist.
  </Card>

  <Card title="The typed frontend surface" icon="react" href="/guides/typed-frontend">
    Path resolution, input and response inference, and what the import costs.
  </Card>

  <Card title="CLI" icon="terminal" href="/reference/cli">
    Every command, shell completion, and what failures look like.
  </Card>

  <Card title="Troubleshooting" icon="life-ring" href="/guides/troubleshooting">
    Exit codes, refused releases, lock problems, and auth that will not cooperate.
  </Card>

  <Card title="Bolt" icon="plug" href="/connectors/bolt">
    Connect Bolt's agent to Xano over MCP and let it author and deploy your backend.
  </Card>

  <Card title="Lovable" icon="heart" href="/connectors/lovable">
    Install the Xano connector and let Lovable's agent author and deploy your backend.
  </Card>
</CardGroup>

## Already have a Xano workspace?

`xanots init my-app --from workspace` pulls your existing backend down as TypeScript (tables,
endpoints, functions, triggers, and settings) and writes a report of anything that did not
survive the round trip. See [Pulling an existing workspace](/guides/codegen).