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

# xanosdk init

> Scaffold a Xano SDK project — empty, or filled from an existing backend. In a non-empty directory, add the backend to the project there.

## Usage

```bash theme={null}
xanosdk init [dir] [options]
```

## Backends

| Slot | Accepts | When omitted |
| - | - | - |
| `--from` | workspace, ephemeral, ephemeral:\<name>, local, local:\<name>, tenant:\<name>, release:\<name>, or a path to a bundle .json | Nothing: name one |

## Flags

| Flag | Description |
| - | - |
| `--name <n>` | Project name (default: the target directory's basename) |
| `--framework <id>` | Frontend to scaffold in a new project: react (default), svelte, or none for the backend only. A non-empty directory always gets the backend only |
| `--theme <id>` | shadcn/ui theme — \<base> or \<base>-\<accent> (e.g. zinc-blue), a registry theme URL, or a registry item JSON path; an unknown id lists every base and accent |
| `--radius <len>` | Corner radius for the scaffold's theme — a number of rem (0, 0.5, 1) or a CSS length |
| `--dark <mode>` | What switches the app into its dark palette: system (default, follows the OS), toggle (adds a control), off |
| `--font <id>` | Body typeface — sans faces only (mono: --font-mono; serif: --font-heading), self-hosted from its @fontsource package (default: the system stack) |
| `--font-mono <id>` | Code typeface — mono faces only (default: the system mono stack) |
| `--font-heading <id>` | Heading typeface, any face, bound to h1–h6 (default: inherits the body face) |
| `--icons <id>` | Icon set: lucide (default), tabler, phosphor |
| `--no-agents-md` | Do not write the AGENTS.md agent brief |
| `--ai <preset\|none>` | For scripted callers: `none` is --no-agents-md; any other value (an agent name) writes the one AGENTS.md every agent reads |
| `--force` | Write over what clashes when adding the backend to a non-empty target directory: an existing xano/, a file init would write, a xano:\* script with another command. It lists every file and script it would overwrite and confirms first (--yes without a terminal); files the scaffold does not write are kept |
| `--no-install` | Skip the post-scaffold npm install |
| `--marketplace <pkgs>` | Marketplace modules to install and register, comma-separated, by the names `marketplace install` takes (auth resolves to @xano-sdk/auth); a name the marketplace does not list exits 8 before anything is written. An add-on install or the project npm install that fails exits 2 with the project left in place |
| `--from <source>` | Fill xano/ by decoding an existing backend instead of writing the empty starter: workspace, ephemeral, ephemeral:\<name>, local, local:\<name>, tenant:\<name>, release:\<name>, or a path to a bundle .json |
| `--web` | Collect the scaffold options in a browser instead of on the command line |
| `--skip-roundtrip` | Do not check that the written tree re-exports as it was pulled (offline; no network, no deploy) |
| `--report <grouped\|full\|json>` | Findings as grouped root causes (default), every site, or JSON |
| `--no-secrets` | Find the documentation tokens and write none — for a machine where a secret on disk is not wanted. The tree still declares the gates, so a later deploy refuses rather than clearing one |
| `--yes, -y` | Confirm without asking what --force overwrites, or what --from replaces in an existing xano/ — required when there is no terminal |
| `--branch <label>` | Read this branch instead of the live one (`--from workspace` only) |
| `--origin <origin>` | Xano OAuth host for `login` and a XANO\_REFRESH\_TOKEN exchange (default: \$XANO\_ORIGIN) |
| `--config <path>` | Explicit credential file (default: \$XANO\_CONFIG) |
| `--local-auth` | Use the project-local ./.xano/auth.json instead of the shared cache |

Global flags are listed in the [CLI overview](/reference/cli).

***

*Generated from @xano/sdk 1.0.9.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.