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.5.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.5-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chesscli-0.2.5.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.5.tar.gz
Algorithm Hash digest
SHA256 217e296a59f6f41834d869aaa1aec3e13208279d408457bbc5eaf2987aaca3e5
MD5 a7910a141bb29ee11ebe6ea47f01bf31
BLAKE2b-256 b2eb026194097c0d5cc0bf23ecb2788ba9515fba356d25333b2e3417ed9d21b2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chesscli-0.2.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e77e46688f15804fc6eb8c0f2f59ef47fadae8e36821e568a17fb4bbef5a4e37
MD5 50612668c0d99a769b8796c7f6db98e8
BLAKE2b-256 c0b3f0160504b94557faa7dcc77ab2c1a34a31409d7f36c39ef1d0b2b664abc6

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