Skip to main content

A CLI for chess application development.

Project description

ChessCLI

ChessCLI is a command-line interface (CLI) tool designed to streamline the development environment for a chess game project. It automates tasks such as setting up the project, opening the codebase in Visual Studio Code, and managing Docker containers.

Features

  • Easy Configuration: Quickly configure the path to your chess game project repository.
  • Code Access: Open your chess game project in Visual Studio Code with a single command.
  • Docker Management: Start and stop your Docker containers directly through the CLI, simplifying your workflow.

Installation

To install ChessCLI, run the following command in your terminal:

pip install chesscli

Usage

Here are some of the commands you can use with ChessCLI:

  • Setup: If you haven't cloned the chess game repository yet, this command helps you clone it and set up your development environment.

    chesscli setup
    
  • Configure: Configure the path to your existing chess game project repository.

    chesscli configure
    
  • Open in VS Code: Open the configured chess game project in Visual Studio Code.

    chesscli code
    
  • Start Docker Containers: Start the Docker containers needed for your project.

    chesscli start
    
  • Stop Docker Containers: Stop the Docker containers.

    chesscli stop
    

Development

Want to contribute? Great! ChessCLI is open for contributions. Whether it's fixing bugs, adding new features, or improving the documentation, all contributions are welcome.

License

ChessCLI is released under the MIT License. See the LICENSE file for more details.

Acknowledgments

  • Thanks to all the contributors who spend time to improve ChessCLI.
  • Special thanks to Typer, which made creating this CLI tool a breeze.

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

chesscli-0.1.0.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

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

chesscli-0.1.0-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chesscli-0.1.0.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for chesscli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 021d8683a19df8a9deaeaa41a5ecfd960077210e5a8899b08f5082593f526bb5
MD5 22e98578707b7e2d51f528c0bc7ede10
BLAKE2b-256 482ab152bb2172ff786c3f61051b8a5b6d234cbf277eea833437b819ad2e6e5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chesscli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for chesscli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e94b58c59eccfad3aafba849d7ee8383c48daccc0ef7bb632229a852134b6c11
MD5 daa68cf11ef5e6a4069871796ff32093
BLAKE2b-256 2e596422d4229bcfc4b066fd625fe40765d9ac336acbb48c46e04bd52b544a78

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