Skip to main content
Documentation navigation

Your first coding task

Open a workspace, configure a provider and model, and start with a narrow read-only task before approving file edits or commands.

1. Open the project you intend to use

cd /path/to/your/project
gaionix-coder tui --help

Workspace tools operate relative to the selected workspace. Review the directory before starting. Never use a real production session as a test fixture.

2. Configure credentials securely

For Gaionix Gateway, provide GAIONIX_GATEWAY_API_KEY or its supported alias GAIONIX_API_KEY through your protected environment or secret manager. For a custom OpenAI-compatible endpoint, use GAIONIX_CUSTOM_API_KEY or OPENAI_API_KEY. Credentials are never command-line options. Do not paste keys into prompts, scripts, repositories, or support reports.

In VS Code, run “Gaionix Coder: Configure Provider Credentials”. Credentials use VS Code SecretStorage. Select the model in Gaionix settings. The CLI uses the process environment rather than the VS Code credential vault.

3. Choose your model and start

gaionix-coder tui --workspace . --model MODEL_ID

# A headless read-only task
gaionix-coder run "Explain this project architecture" \
  --workspace . --model MODEL_ID --plan-mode

Replace MODEL_ID with a model available from your provider. No cheaper-model fallback is chosen automatically. For custom endpoints add --provider custom-openai-compatible --custom-base-url https://YOUR_ENDPOINT/v1.

4. Review each action

Start with a narrow task. The default access mode asks for approval; noninteractive run rejects requests it cannot approve. Use the TUI or VS Code for interactive approvals. Inspect file changes and diffs before committing. Tool execution can affect your workspace.

5. Follow up safely

Use Queue during active work, Steer when you need to redirect the current turn, and Stop to request cancellation. Continue or Retry may be blocked when cleanup or side effects remain uncertain. See agent controls.