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

Uploaded Python 3

File details

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

File metadata

  • Download URL: chesscli-0.2.2.tar.gz
  • Upload date:
  • Size: 4.1 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.2.tar.gz
Algorithm Hash digest
SHA256 ccd3bd05149823bb9268c99ebee9ec87236002a8e5e8356306ccb478c5f0b16f
MD5 ea23963ca119a4c8df469a7d60b6b6be
BLAKE2b-256 e3091e0bdfd71d4af68ba1701faeb9cae03ac4e4a38897c182ea97682abb7cd3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chesscli-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7d73ebc703eb3385a3399ab741a82abdeef7bb570c70188045a45e88efc8220b
MD5 0af1dc1bb60dfb0d98175ddc60df1f7e
BLAKE2b-256 dcca81b8f86e7b0d8436ad7b94e56cdf7fc2bc32a61b42e5c157c9f3bc0c6dd9

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