Metadata-Version: 2.4
Name: helixor
Version: 0.3.4
Summary: Lightweight Helixor CLI for hub login, cloud-trial indexing, companion registration, and MCP endpoint configuration.
Author-email: Michael Ingardia <mingardia@end2endlogic.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: httpx>=0.27
Requires-Dist: msgpack>=1.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"

# helixor

Durable code memory and verified understanding for AI coding agents.

```zsh
pipx install helixor            # after PyPI publication
helixor up                      # starts companion-lite + tray
helixor index ~/code/my-repo
helixor mcp-config --transport http
helixor agent install           # choose Claude, Codex, Grok, or generic MCP
```

Agent-specific setup is available through the umbrella installer:

```zsh
helixor agent install claude       # opens the Claude Desktop extension installer
helixor agent install codex        # writes ~/.codex/config.toml
helixor agent install grok         # prints/writes generic MCP JSON for Grok MCP settings
helixor agent install mcp-generic  # prints/writes generic MCP JSON
```

`helixor claude install` remains available as a compatibility shortcut for the
Claude Desktop MCP Bundle.

The CLI checks PyPI at most once every 24 hours. When a newer version is
available in an interactive terminal, it shows the exact upgrade command and
asks before running it. Non-interactive commands are never paused; they receive
an update warning instead. Use `--no-update-check` for one invocation or set
`HELIXOR_CLI_NO_UPDATE_CHECK=1` to disable automatic checks.

For maintainers building the bundle from a checkout:

```zsh
cd helixor-cli/claude-extension
node scripts/pack.mjs
```

For the current wheel-bundle release channel:

```zsh
python3 -m pip install --find-links helixor-wheelhouse helixor
```

The public CLI is the cloud-trial runtime. It does not bundle private Helixor
Code backend or `helix-core` packages. `helixor up` starts a lightweight local
companion at `http://127.0.0.1:18733` plus the tray app. The companion scans the
local index store, reports token/value ledgers, exposes tray health, and
delegates proprietary build/query execution to the configured Helixor cloud RPC
API.

In trial mode, `helixor index` uploads a bounded source snapshot and the
protected Helixor cloud builds and queries the index cache. The public wheel
keeps only credentials, receipts, setup metadata, and diagnostics.

Enterprise local execution is a swap at the companion/provider boundary. The
public CLI may start an installed enterprise companion with:

```zsh
helixor up --companion-provider enterprise-local
```

but the enterprise package owns any local Jewel/Helix execution dependencies.
Enterprise local is the premium path for private-source teams that need the
fastest loop: the licensed companion builds and queries local indexes while the
cloud records license acceptance, companion registration, shared workspace
state, token ledgers, and team coordination.

Build and verify the bundle from the monorepo:

```zsh
PYTHON=python3.12 scripts/package-helixor.sh --smoke
```

Start with:

- `docs/quickstart-cursor.md` for Cursor MCP setup.
- `docs/quickstart-collab.md` for team hub or direct collaboration mode.
