Pyckle Docs - Getting Started

Installation

1

Install Pyckle

Run the one-line installer:

curl -sL pyckle.co/install | bash

This creates ~/.pyckle/ and configures your AI coding environment.

2

Authenticate

Add your API key (from your dashboard):

pyckle auth pk_live_your_key_here

3

Index your project

Navigate to your project and index it:

cd /path/to/your/project
pyckle index .

This scans your codebase, chunks the code, and uploads to Pyckle for embedding.

Start coding

That's it! Open your AI coding assistant and ask questions about your code. Relevant context will be injected automatically.

CLI Commands

Command	Description
`pyckle auth <key>`	Save your API key
`pyckle index [path]`	Index a project (default: current directory)
`pyckle projects`	List indexed projects
`pyckle status`	Check connection and subscription status
`pyckle delete <project>`	Delete an indexed project
`pyckle uninstall`	Remove Pyckle completely

How It Works

Indexing

When you run pyckle index, we:

Scan your project for code files
Split files into semantic chunks
Upload chunks to Pyckle cloud
Generate embeddings using PyckLM
Store in vector database

Routing

When you ask your AI assistant a question:

Hook intercepts the prompt (~1ms)
Sends prompt to Pyckle API
API searches your index (~30-50ms)
Top 3 relevant chunks returned
Chunks injected into prompt

Total latency: Typically ~50ms. Actual latency may vary based on codebase size, network conditions, and hardware.

Configuration

Config file location: ~/.pyckle/config.json

{
  "api_key": "pk_live_...",
  "api_url": "https://api.pyckle.co",
  "projects": {
    "/path/to/project": "project_abc123"
  }
}

Re-indexing

Run pyckle index . again to update the index after significant code changes. The old index is replaced.

Multiple Projects

Index as many projects as you want. Routing automatically uses the correct index based on your current working directory.

Privacy & Security

Code chunks are encrypted in transit (HTTPS)
Stored in isolated per-customer collections
We never train on your code
Delete anytime with pyckle delete
Cancel subscription = all data deleted within 30 days

Troubleshooting

Hook not working

Check that the hook is in your settings:

cat ~/.claude/settings.json | grep pyckle

Context not appearing

Make sure you're in an indexed project directory
Run pyckle status to check connection
Check logs: cat ~/.pyckle/hook.log

Re-install

pyckle uninstall
curl -sL pyckle.co/install | bash

Getting Started