Unified CLI framework for CrewPlus services
Project description
CrewPlus CLI
Unified command-line interface framework for CrewPlus services.
Installation
pip install crewplus-cli
Usage
The recommended workflow is to create a root directory for all your local plugins.
1. Create a workspace for your plugins
mkdir my-crew-plugins cd my-crew-plugins
2. Scaffold a new extension inside your workspace
crewplus-cli create extension my-first-plugin --mode code
3. Run the agent, loading your new plugin
crewplus-cli server agent \ --local-extensions ./ \ --enable-plugins my_first_plugin
View all available commands
crewplus-cli --help
Architecture
crewplus-cli is a lightweight framework that discovers and loads commands from various CrewPlus service packages via Python entry points.
For Service Developers
To register commands from your service package:
- Create a CLI module in your service (e.g.,
src/your_service/cli.py) - Create a Typer app instance for your command group
- Register it in your
pyproject.toml:
[project.entry-points."crewplus.cli"] server = "your_service.cli:server_group"Example CLI module:
import typer
server_group = typer.Typer(name="server", help="Server commands")
@server_group.command("start") def start_server(): """Start the server""" # Your implementation pass## Development
Install in development mode
pip install -e .
Run tests
pytest
Deploy to PyPI
Clean Previous Build Artifacts:
Remove the dist/, build/, and *.egg-info/ directories to ensure that no old files are included in the new build.
rm -rf dist build *.egg-info
install deployment tool
pip install twine
build package
python -m build
Deploy to official PyPI
python -m twine upload dist/*
Project details
Release history Release notifications | RSS feed
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 crewplus_cli-0.1.2.tar.gz.
File metadata
- Download URL: crewplus_cli-0.1.2.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1a83a06f134a68304f8d3d555a982e15bb5b80c600279cbc87f03e8b234c30d
|
|
| MD5 |
196bda453695fb507234d3f7e806a4bb
|
|
| BLAKE2b-256 |
4047811f1181418c1f9a445d36a413ffe2be5808fbd76cf477297493baa6272e
|
File details
Details for the file crewplus_cli-0.1.2-py3-none-any.whl.
File metadata
- Download URL: crewplus_cli-0.1.2-py3-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bba4544e396958abb71bb9a60f5f88d2531631f5188460bcf3b45af9aa997355
|
|
| MD5 |
67f86cd18d1d08bc360291790dc3e5f8
|
|
| BLAKE2b-256 |
c73438248ac5d2147a9703482a9560ae705750ae2c199dd5b186907ea6ad8069
|