Python SDK and command-line interface for the LimaCharlie endpoint detection and response platform.
- Documentation — CLI reference, SDK guide, authentication
- Platform Docs | REST API | Issues
pip install limacharliedocker run refractionpoint/limacharlie:latest --helpSee Getting Started for Docker credential mounting and first steps.
limacharlie auth login --oid YOUR_ORG_ID --api-key YOUR_API_KEY
limacharlie auth whoami
limacharlie org info
limacharlie sensor listSee Authentication for OAuth, environments, credential resolution, JWT caching, and config directory migration.
| Guide | Topics |
|---|---|
| Getting Started | Installation, Docker, first steps |
| Authentication | API keys, OAuth, environments, JWT caching, config migration |
| CLI Overview | Command pattern, output formats, filtering, discovery |
| SDK Overview | Architecture, setup, class reference |
Full reference: doc/README.md
The CLI supports tab-completion for all commands, subcommands, and options.
Bash - add to ~/.bashrc:
eval "$(limacharlie completion bash)"Zsh - add to ~/.zshrc:
eval "$(limacharlie completion zsh)"Fish - run once:
mkdir -p ~/.config/fish/completions
limacharlie completion fish > ~/.config/fish/completions/limacharlie.fishRestart your shell (or source the rc file) for completions to take effect.
If you prefer not to run eval on every shell start, you can write the completion script to a file once. This is slightly faster at shell startup but needs to be re-run after upgrading to pick up new commands and options.
Bash:
mkdir -p ~/.local/share/bash-completion/completions
limacharlie completion bash > ~/.local/share/bash-completion/completions/limacharlieZsh:
mkdir -p ~/.zfunc
limacharlie completion zsh > ~/.zfunc/_limacharlieEnsure ~/.zfunc is in your fpath by adding this to ~/.zshrc (before compinit):
fpath=(~/.zfunc $fpath)
autoload -Uz compinit && compinitgit clone https://github.com/refractionPOINT/python-limacharlie.git
cd python-limacharlie
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"The editable install (-e) means changes to the source code take effect immediately without reinstalling.
After the editable install, the limacharlie command is available in your venv:
limacharlie --version
limacharlie --help
limacharlie sensor list --helpUnit tests run without any credentials or network access:
# All unit tests
pytest tests/unit/ -v
# Single test file
pytest tests/unit/test_client.py -v
# Single test case
pytest tests/unit/test_client.py::TestClientInit::test_creates_with_explicit_creds -vIntegration tests require a real LimaCharlie organization:
pytest tests/integration/ --oid YOUR_ORG_ID --key YOUR_API_KEY -vpip install build && python -m build
pip install dist/limacharlie-*-py3-none-any.whl && limacharlie versionReleases are published to PyPI automatically via GitHub Actions when a version tag is pushed. The package version is derived from the git tag using setuptools-scm — there is no hardcoded version to bump.
git tag 5.1.0
git push origin 5.1.0The workflow runs unit tests, builds the package, and publishes to PyPI using Trusted Publishers (OIDC) — no API tokens or secrets required. See .github/workflows/publish-to-pypi.yml for details.