Skip to main content

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

engram_connect-0.3.2.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

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

engram_connect-0.3.2-py3-none-any.whl (47.7 kB view details)

Uploaded Python 3

File details

Details for the file engram_connect-0.3.2.tar.gz.

File metadata

  • Download URL: engram_connect-0.3.2.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for engram_connect-0.3.2.tar.gz
Algorithm Hash digest
SHA256 c638d77afd16f953468e1563ab7fda4646c2aba973a20b621b6c87e1190f969b
MD5 8aa30be9552a423959a05fab32b55b90
BLAKE2b-256 66b26d6daeea129adb4f611bbd2c3d99403b519e60417086e6bc67e3f90cefca

See more details on using hashes here.

Provenance

The following attestation bundles were made for engram_connect-0.3.2.tar.gz:

Publisher: publish-pypi.yml on Barsoomx/engram

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file engram_connect-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: engram_connect-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 47.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for engram_connect-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4b9cf208bb26858ac4a4660aa40763b45f5ad1de11af7e83946d9883800471ae
MD5 6b0da8672dd57dbaa5d39ba2f61a9ec5
BLAKE2b-256 aa29fcd3955405313e05535dd23d681703a7cae29811cc360617bb5eecf44203

See more details on using hashes here.

Provenance

The following attestation bundles were made for engram_connect-0.3.2-py3-none-any.whl:

Publisher: publish-pypi.yml on Barsoomx/engram

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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