Configuration

The ticketyboo-gate extension has two settings. Both are scoped to VS Code User or Workspace settings. Set them before running the Brief Wizard.

Settings reference

Setting your API key

Via VS Code settings UI

1. Open VS Code Settings (Ctrl+, / Cmd+,).
2. Search for ticketyboo.
3. Enter your API key in the ticketyboo: Api Key field.

Via settings.json

Open your settings.json (Preferences: Open User Settings (JSON) from the Command Palette) and add:

{
  "ticketyboo.apiKey": "tbo-your-key-here"
}

Generating an API key

API keys are generated from your account page after signing in:

1. Sign in at ticketyboo.dev.
2. Go to your account page.
3. Under API keys, click Generate key.
4. Copy the key (it is shown once). It begins with tbo-.
5. Paste it into the ticketyboo.apiKey setting.

API keys are stored as a SHA-256 hash in DynamoDB. The full key value is not retrievable after generation. If you lose the key, generate a new one.

Changing the API base URL

The default API base is https://api.ticketyboo.dev. This is correct for all normal use. You would only change ticketyboo.apiBase if you are running a local development instance of the ticketyboo API (for example, via LocalStack or a local Lambda invocation).

{
  "ticketyboo.apiBase": "http://localhost:3000"
}

How the extension uses settings

When you run ticketyboo: Open Brief Wizard, the extension reads both settings and uses them to construct the API requests:

• GET {apiBase}/v1/archetypes with header x-api-key: {apiKey}
• POST {apiBase}/v1/archetypes/{name}/instantiate with header x-api-key: {apiKey}

If ticketyboo.apiKey is empty, the extension shows an error message and does not proceed.

Next steps

• Guide: create your first contract
• Archetypes reference