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.1.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.2.1-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chesscli-0.2.1.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.2.1.tar.gz
Algorithm Hash digest
SHA256 f75b38487a72d1eb701edaba4ac6f8b084365877064141f1b4cf38f05f6510b1
MD5 00fcb87461d76e036b3b63554ed48c08
BLAKE2b-256 516f8807dee5d03a6ffd0030e80c56e4fae570c9729cf65595cb082edc969122

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chesscli-0.2.1-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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 351a93c9b4032263488af5907cc9ae44af2381bf7159416e3157e20e0919ad79
MD5 f130379e589e5ae6eb336c7a880eee40
BLAKE2b-256 b64dcd72bb92eb40b9edb38e13c56f1d614e9abeaad20c969d1a8d6b3c518616

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