Thin Engram command-line client
Project description
CLI
Owns the first engram command-line client for connecting a developer machine
to an already-running Engram server.
Current command surface:
python -m engram_cli connect --server URL --api-key KEY --project PROJECT
python -m engram_cli doctor
python -m engram_cli hook post-tool-use < hook.json
python -m engram_cli hook session-start < context.json
python -m engram_cli hook error < hook.json
python -m engram_cli hook decision < hook.json
python -m engram_cli hook session-start --response-format codex < hook.json
python -m engram_cli disconnect
The package declares two console scripts in pyproject.toml that share the same
entrypoint: engram (short, for typed commands) and engram-connect (matches the
distribution name, so uvx engram-connect ... works without --from).
Plug-and-play install (engram install)
engram install is the one-command onboarding path for a Claude Code harness.
It validates the server, API key, and project scope (same dry-run as connect),
writes local credentials under ~/.engram, installs the Engram Claude Code
plugin through the native claude plugin marketplace, and finishes with a
doctor health check.
Run it without cloning the repo via uvx:
uvx engram-connect install \
--server <URL> --api-key <KEY>```
Before the package is published to PyPI, install straight from git or `pipx`:
```bash
uvx --from "git+https://github.com/Barsoomx/engram.git#subdirectory=packages/cli" \
engram install --server <URL> --api-key <KEY># or:
pipx install engram-connect
engram install --server <URL> --api-key <KEY>```
The plugin steps run `claude plugin marketplace add <--marketplace-source>` then
`claude plugin install <--plugin-name>@<--marketplace-name>` using the `claude`
binary on PATH (override with `--claude-bin`). Pass `--skip-plugin-install` to
write credentials and run `doctor` without touching the harness. The bundled
plugin hooks require `python3 >= 3.12` on PATH.
Local state defaults to `$ENGRAM_HOME` when set, otherwise `~/.engram`.
`connect` writes only Engram-owned config, credential, and hook-manifest files.
`doctor` is read-only. `disconnect` removes only Engram-owned files.
Hook commands read one JSON object from stdin, merge the connected project,
team, runtime, and credential metadata, and call the Engram server. By default
they print the server JSON response. Codex response mode prints the Codex hook
response instead.
The CLI must not introduce a persistent local memory service, local database,
provider secrets, embeddings, cached memory bundles, durable event queue, or
background summarization behavior.
Run tests from the repository root:
```bash
PYTHONPATH=packages/cli python3 -m unittest discover -s packages/cli -p '*_tests.py' -v
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file engram_connect-0.1.4.tar.gz.
File metadata
- Download URL: engram_connect-0.1.4.tar.gz
- Upload date:
- Size: 30.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7aacd2e6da2901d3f5054ca990f44d75de20bffac48ec46cb9da518cdabbb485
|
|
| MD5 |
ebd75cdd658e86ebe3ef16b871bed025
|
|
| BLAKE2b-256 |
1657febdc476ae90d92810079e339c2d3282e7a501af5a3e0664478e2eb2d6e1
|
Provenance
The following attestation bundles were made for engram_connect-0.1.4.tar.gz:
Publisher:
publish-pypi.yml on Barsoomx/engram
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
engram_connect-0.1.4.tar.gz -
Subject digest:
7aacd2e6da2901d3f5054ca990f44d75de20bffac48ec46cb9da518cdabbb485 - Sigstore transparency entry: 2047783516
- Sigstore integration time:
-
Permalink:
Barsoomx/engram@d6938296d994fe887264e7b3f58c48bf36e7c3c9 -
Branch / Tag:
refs/tags/engram-connect-v0.1.4 - Owner: https://github.com/Barsoomx
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@d6938296d994fe887264e7b3f58c48bf36e7c3c9 -
Trigger Event:
push
-
Statement type:
File details
Details for the file engram_connect-0.1.4-py3-none-any.whl.
File metadata
- Download URL: engram_connect-0.1.4-py3-none-any.whl
- Upload date:
- Size: 32.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a437f4ddf6dea0653e7f9e5b88de94c430642c18712153046eb7b1c2c9124f21
|
|
| MD5 |
9fd6768b713b45fe970f21bedd234fe6
|
|
| BLAKE2b-256 |
f98c6b2a69e78c23413e68743d3148e12039c04b4106f7ae3d52aeda4d56ec61
|
Provenance
The following attestation bundles were made for engram_connect-0.1.4-py3-none-any.whl:
Publisher:
publish-pypi.yml on Barsoomx/engram
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
engram_connect-0.1.4-py3-none-any.whl -
Subject digest:
a437f4ddf6dea0653e7f9e5b88de94c430642c18712153046eb7b1c2c9124f21 - Sigstore transparency entry: 2047783523
- Sigstore integration time:
-
Permalink:
Barsoomx/engram@d6938296d994fe887264e7b3f58c48bf36e7c3c9 -
Branch / Tag:
refs/tags/engram-connect-v0.1.4 - Owner: https://github.com/Barsoomx
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@d6938296d994fe887264e7b3f58c48bf36e7c3c9 -
Trigger Event:
push
-
Statement type: