Specra Docs

VS Code extension

Connect a local codebase to a Specra project and sync artifacts into your workspace.

The VS Code extension is designed for teams that want to keep generated artifacts close to the code they are implementing.

Core commands

  • Specra: Login
  • Specra: Configure Project
  • Specra: Generate
  • Specra: Pull Reference Images
  • Specra: Push Reference Images
  • Specra: Run Extraction
  • Specra: Push and Run Extraction
  • Specra: Open Project Online

Project config

The extension uses .specra.json at the workspace root.

Typical fields include:

{
  "projectId": "your-project-id",
  "outputsDir": "src/generated",
  "referencesDir": ".specra/references"
}
  1. Log in from VS Code.
  2. Link the workspace to a Specra project.
  3. Pull references if you want the local workspace to mirror the project.
  4. Push new references from referencesDir.
  5. Run extraction.
  6. Generate to sync the latest artifacts into your app.

Notes

  • Generate does not create a new run. It fetches the latest successful revision.
  • Push Reference Images syncs the configured references directory and skips duplicates.
  • Push and Run Extraction is the fastest way to update a project from local changes.

On this page