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

# Setup

> Commands for building and verifying Vaulkyrie from source.

<Warning>
  Vaulkyrie is not audited yet. Use these commands for development, review, and test environments only.
</Warning>

## Browser wallet

```bash theme={null}
npm install
npm run dev
npm run build
npm run lint
```

The browser wallet scripts come from `package.json`:

| Script            | Purpose                                                  |
| ----------------- | -------------------------------------------------------- |
| `npm run dev`     | Starts the Vite development server.                      |
| `npm run build`   | Runs TypeScript project build and Vite production build. |
| `npm run lint`    | Runs ESLint across the browser wallet source.            |
| `npm run preview` | Serves the built Vite output.                            |

## Relay server

```bash theme={null}
cd relay-server
npm install
npm run build
npm run dev
```

The relay server scripts come from `relay-server/package.json`:

| Script          | Purpose                                         |
| --------------- | ----------------------------------------------- |
| `npm run dev`   | Runs `tsx watch src/server.ts`.                 |
| `npm run build` | Compiles the relay server TypeScript.           |
| `npm start`     | Runs the compiled server from `dist/server.js`. |

## Rust workspace

Run these from the Rust workspace root.

```bash theme={null}
cargo build --workspace
cargo test --workspace
cargo fmt --all --check
```

The workspace contains:

* `crates/vaulkyrie-cli`
* `crates/vaulkyrie-frost`
* `crates/vaulkyrie-frost-wasm`
* `crates/vaulkyrie-protocol`
* `crates/vaulkyrie-sdk`
* `programs/vaulkyrie-core`

## Docs site

Run these from the Mintlify docs repository if you are contributing to documentation.

```bash theme={null}
npm i -g mint
mint validate
mint dev
```

The hosted documentation is available at [https://vaulkyrie.mintlify.app/](https://vaulkyrie.mintlify.app/).