Skip to main content

COESI Platform CLI - Command line interface for managing COESI Docker deployments

Project description

COESI CLI

A command-line interface for managing COESI Platform Docker deployments.

Installation

From PyPI (Recommended)

pip install coesi

From Source

git clone https://github.com/coesi/coesi-cli.git
cd coesi-cli
pip install -e .

Usage

After installation, you can use the coesi command globally:

# Deploy development environment
coesi dev

# Deploy production with default IP
coesi prod

# Deploy production with custom IP
coesi prod 10.0.0.100

# Restart services
coesi restart dev
coesi restart prod

# Stop services
coesi stop dev
coesi stop prod
coesi stop all

# Check status
coesi status
coesi status dev
coesi status prod

# View logs
coesi logs
coesi logs core-api

# Clean environments
coesi clean dev
coesi clean prod
coesi clean all

# Update production IP
coesi ip 192.168.1.100

# Show help
coesi --help

Commands

coesi dev

Deploy development environment with localhost (no IP parameter allowed).

coesi prod [IP]

Deploy production environment with optional IP address. Uses default IP if not specified.

coesi restart [PROFILE]

Restart services without rebuilding (dev or prod).

coesi stop [PROFILE]

Stop services (dev, prod, or all).

coesi status [PROFILE]

Show service status (dev, prod, or all).

coesi logs [SERVICE]

View logs for specific service or all services.

coesi clean [PROFILE]

Remove containers and volumes (dev, prod, or all).

coesi ip [IP]

Change production IP in .env.prod file.

Requirements

  • Docker
  • Docker Compose
  • Python 3.8+

Development

Setup Development Environment

# Clone the repository
git clone https://github.com/rezathriii/coesi-cli.git
cd coesi-cli

# Install in development mode
pip install -e .[dev]

Running Tests

pytest

Code Formatting

black src/
flake8 src/
mypy src/

Publishing to PyPI

# Build the package
python -m build

# Upload to PyPI
twine upload dist/*

License

MIT License - see LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Run the test suite
  6. Submit a pull request

Support

For issues and questions, please visit: https://github.com/rezathriii/coesi-cli/issues

Author

Reza Taheri

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

coesi-0.1.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

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

coesi-0.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file coesi-0.1.0.tar.gz.

File metadata

  • Download URL: coesi-0.1.0.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for coesi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0979dd4ad65c8871231b6d25a6aa6d96e7008b22454965f2030c068770c6ab0b
MD5 19ca6b8016b4bff1bd5ae4ebc79cb369
BLAKE2b-256 17b85779d076fe1ec2c85831ec6221be1a25a0429bd2c5d57f3bbf5c3f5180c1

See more details on using hashes here.

File details

Details for the file coesi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: coesi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for coesi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd79ce126b90664a19beaacf04eaf8d4013aeb62fe23c5395556b5fdecf562c2
MD5 c99d8391f13aa67ea44b64f5b6a6cb68
BLAKE2b-256 ab99c9064acf84f9a24df6f4f79c6dd18f061a4a0cefdad427ec80ef760b6f2f

See more details on using hashes here.

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