Skip to content
AI Setup
Tasklynx
Github.com

AI Setup

AI is opt-in. The default build has no networking dependency and the default provider is none.

Build with AI support

cargo build --features ai
# or install the feature-enabled build:
cargo install --git https://github.com/peekstore/tasklynx.git --locked --features ai

The ollama and openai-compatible providers are compiled only with the ai feature. Official release binaries are built without it, so installers and package-manager releases support offline triage but not provider-backed AI. Core task management and offline triage work without the feature.

Configure a provider

Add an [ai] table to config.toml:

[ai]
provider = "none"
model = "llama3.1"
endpoint = "http://127.0.0.1:11434"
max_context_tasks = 50
include_descriptions = true
redact = true
Key Default Purpose
provider "none" none, ollama, or openai-compatible
model "llama3.1" Model name sent to the provider
endpoint "http://127.0.0.1:11434" Provider base URL
max_context_tasks 50 Maximum open tasks included in prompt context
include_descriptions true Include task descriptions in context
redact true Redact common secret patterns before sending prompts

Set TASKLYNX_AI_API_KEY for hosted OpenAI-compatible endpoints. API keys are never written to config.toml.

Ollama

[ai]
provider = "ollama"
model = "llama3.1"
endpoint = "http://127.0.0.1:11434"

tx ai doctor

OpenAI-compatible endpoints

[ai]
provider = "openai-compatible"
model = "gpt-4.1-mini"
endpoint = "https://api.openai.com/v1"

export TASKLYNX_AI_API_KEY="your-api-key"
tx ai doctor

Include the API version path in endpoint, such as /v1 or /v1beta/openai.

Google Gemini

[ai]
provider = "openai-compatible"
model = "gemini-2.5-flash"
endpoint = "https://generativelanguage.googleapis.com/v1beta/openai"

export TASKLYNX_AI_API_KEY="your-ai-studio-key"
tx ai doctor

Commands

tx ai plan "Ship the billing API"
tx ai plan "Ship the billing API" --project api --limit 8 --apply

tx ai breakdown <id>
tx ai breakdown <id> --apply

tx ai triage
tx ai triage --offline --include-blocked
tx ai standup --days 1 --project api
tx ai review feature-auth --days 14
tx ai ask "What should I do next?"
tx ai ask "What changed this week?" --branch main --project api
  • Mutating commands preview by default and require --apply.
  • tx ai triage falls back to deterministic tx next ranking when no provider is configured or --offline is passed.
  • --limit N, --project, --branch, and --no-description tighten context.
  • CLI, TUI, and web expose the same preview and apply behavior.

Privacy and safety

  • AI commands are the only code path that can send task data to a provider.
  • Context is limited to the selected project and branch.
  • Common secrets are redacted when ai.redact is enabled.
  • Prompt contents are never logged. TASKLYNX_AI_LOG=1 logs prompt size and provider latency only.
  • Responses are validated against a strict schema before tasks are created.
  • Blocked tasks are excluded from triage unless explicitly requested.
  • AI output never auto-completes, auto-deletes, or auto-commits anything.

Troubleshooting

tx ai doctor

Use tx ai doctor to check provider reachability, model availability, and configuration. If the binary was built without the ai feature, provider-backed commands explain how to rebuild.