Before you start
The extension drives the local Rust CLI. Both components are required.
- VS Code 1.96 or newer.
- A Naquada account on the production service.
- The Naquada CLI available as the
naquadacommand. - Codex in VS Code to launch pipelines from chat.
Check
naquada --version returns in the integrated terminal.Install both components
Install the CLI
Follow the macOS, Windows, or Linux guide first. The CLI stores your session in the operating-system credential vault.
Naquada CLI guide →Install the extension
Install “Naquada for Codex” from the Marketplace, then reload VS Code.
Distribution link not configured
code --install-extension naquada.naquada-vscodeVerify the installation
A Naquada icon appears in the activity bar and “Naquada: sign in” is available in the Command Palette.
Connect the project and Codex
Sign in
Open the Command Palette (⇧⌘P on macOS, Ctrl+Shift+P on Windows/Linux), run “Naquada: sign in,” then approve the code in your browser.
naquada loginLink the current folder
Run “Naquada: link this project.” Choose a stable name and tag. Naquada only creates the local .naquada folder and a remote context owned by your account.
naquada project link --name "My project" --tag my-projectRegister Naquada with Codex
Run “Naquada: connect Codex via MCP,” confirm, then reload the window. The CLI command below performs the same registration.
naquada setup codex --applyConcrete check
naquada is enabled and its planning tools are visible.Create a first asset without leaving VS Code
Request a precise result and always provide a relative destination. Codex prepares the plan; paid execution only starts after the approval required by your settings.
Use Naquada to create a 512 × 512 pixel-art magic chest icon with a transparent background. Save the original to assets/generated/chest.png. Show me the plan and estimated cost before execution.Review the model, configuration, inputs, estimated cost, and especially assets/generated/chest.png, then approve.
Expected result you can verify
- The run appears in “Naquada — Runs and assets.”
- The local receipt names the Naquada tool, approved plan, and final path.
assets/generated/chest.pngexists and opens in VS Code.- The delivered file hash is recorded in
.naquada/runs/<run-id>.json.
Understand where files go
Every path supplied to Naquada is relative to the open project root.
.naquada/runs/stores receipts required for tracking and recovery..naquada/assets/is temporary delivery staging, not a synchronized library.- The verified file is moved to the final path requested by the AI.
- Local references are uploaded only when a specific file or allowed folder is explicitly selected.
Name collisions
image.png becomes image-02.png, for example.What Naquada never does implicitly
VS Code workspace trust and explicit consent remain required for sensitive actions.
- No full-repository scan or upload.
- No automatic synchronization of your online asset library.
- No Git commands, commits, or branch changes.
- No asset download without an approved run and local receipt.
- The interactive session is stored in Keychain, Windows Credential Manager, or Linux Secret Service.
Close VS Code without losing a generation
Generation continues on Naquada. The extension does not block the chat while it waits.
- After restart, it reads only approved receipts in
.naquada/runs/. - It resumes incomplete downloads and verifies SHA-256.
- A notification confirms delivery or reports that recovery is needed.
- You can run “Resume delivery” manually from the Naquada view.
Diagnose the setup in under a minute
Run “Naquada: diagnose integration” or the following command.
naquada --json doctorauthenticatedmust betrue.projectLinkedmust betrue.apiReachablemust betrue.gitTouchedmust always befalse.
Result
ok is true, the account, project, production API, and recovery directories are ready.