Skip to main content

AI-powered CLI development assistant

Project description

Cognix

Autonomous code generation powered by flow engineering.

Version License Python


Quick Start

1. Install and run

pipx install cognix
cognix

2. First-time setup

When you run Cognix for the first time, an interactive wizard will help you set up your API key:

  • Choose your AI provider (Anthropic, OpenAI, or OpenRouter)
  • Enter your API key
  • The wizard creates a ~/.cognix/.env file automatically

3. Generate code

Try the included sample first (use @ to specify a file):

cognix> /make @sample_spec_tetris.md

Or describe what you want to build:

cognix> /make "landing page with HTML and CSS"

A sample specification file sample_spec_tetris.md is included in the repository. Use it as a reference for writing your own specifications.

4. Available commands

Type /help in the CLI to see all available commands.


API Key Setup

Automatic setup (recommended)

Just run cognix and follow the interactive wizard.

Manual setup

Edit the ~/.cognix/.env file (Windows: C:\Users\<username>\.cognix\.env):

Anthropic Claude (default):

ANTHROPIC_API_KEY=sk-ant-your_key_here

Get your key at: https://console.anthropic.com/

Supported models: Sonnet 4.5 (default), Opus 4.6, Opus 4.5

OpenAI:

OPENAI_API_KEY=sk-your_key_here

Get your key at: https://platform.openai.com/api-keys

Supported models: GPT-5.2, GPT-5.2 Codex

OpenRouter:

OPENAI_API_KEY=sk-or-v1-your_key_here
OPENAI_BASE_URL=https://openrouter.ai/api/v1

Get your key at: https://openrouter.ai/keys

Switch models

cognix> /model

MCP Server Integration

Use Cognix from Claude Desktop, Cursor, VSCode, or any MCP-compatible tool.

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "cognix": {
      "command": "cognix-mcp"
    }
  }
}

Data Storage

Cognix stores data in ~/.cognix/:

~/.cognix/
├── .env                            # API keys & credentials
├── config.json                     # Your settings
├── memory.json                     # Conversation & project memory
├── repository_data.json            # Repository analysis cache
├── ui-knowledge.json               # UI component knowledge
├── app_patterns.json               # App pattern definitions
├── default_file_reference_rules.md # File reference rules
├── sessions/                       # Saved work sessions
├── backups/                        # Automatic backups
├── logs/                           # Debug logs
├── temp/                           # Temporary files
└── impact_analysis/                # Code impact analysis results

Privacy: No telemetry. API calls only go to your configured LLM provider.


System Requirements

  • OS: Windows 10+, macOS 10.15+, or Linux
  • Python: 3.9 or higher
  • Internet: Required for LLM API access

Links


License

Apache-2.0 License - see LICENSE file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cognix-0.2.4.tar.gz (493.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cognix-0.2.4-py3-none-any.whl (514.7 kB view details)

Uploaded Python 3

File details

Details for the file cognix-0.2.4.tar.gz.

File metadata

  • Download URL: cognix-0.2.4.tar.gz
  • Upload date:
  • Size: 493.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for cognix-0.2.4.tar.gz
Algorithm Hash digest
SHA256 6d375305d1dde074207cdd3a3de1586f38fe3afdd01fa929173a3b70c413239d
MD5 ea3fee67ca4cfc0fb7a25faba54e5867
BLAKE2b-256 642813c8309dc7a00f228c8677048d80bbb8a4457c975bcf8933608cd6366996

See more details on using hashes here.

File details

Details for the file cognix-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: cognix-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 514.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for cognix-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7d7efcd73218b9c86b0f4127b5d4813b9697dac8c3df307f9e943817e1efc17
MD5 803162419bbf7411c841c193ac5396fc
BLAKE2b-256 48f8fe39a48540e039d53698b457fa58e126861fd239b0ce44c17fd77c596481

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page