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.2.4.tar.gz (4.2 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.2.4-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for chesscli-0.2.4.tar.gz
Algorithm Hash digest
SHA256 06908dfbadfe1b3d806ca29d5b11c4507bf87ab09e2e17b38ddcbe5886714451
MD5 54cad51c4f20778558293b127ff91830
BLAKE2b-256 cb6754cd5d83fa1e3912d10f26e9b5470d43f7b2bfefbc4a216ef9cabe9918c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chesscli-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 4.4 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.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f6e204048a54a62df9bb38ccb63eb9cdb0966211af3b48da6b169d4e30fa63
MD5 ed273ebd7fb3f0a5d4b469674f8f6ea6
BLAKE2b-256 40eecdfebb9c2f1337bc2332a27f2bce55503e617fe3f70438e8d81a6932e6d7

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