Skip to content

First official release

Latest
Compare
Choose a tag to compare
@LennyMaxMine LennyMaxMine released this 21 Jul 22:20

This is the first official release of ShipwreckedCLI, a powerful terminal-based client for Hack Club's Shipwrecked hackathon website, built with Python to provide nearly complete functionality equivalent to the web interface.

Requirements

  • Python 3.7+
  • Dependencies listed in requirements.txt
  • Valid Shipwrecked account credentials

Installation

To install ShipwreckedCLI please

  1. Clone the repository

    git clone https://github.com/LennyMaxMine/shipwreckedcli
    
    cd ShipwreckedCli
  2. Create a virtual environment

    python -m venv venv
    
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies

    pip install -r requirements.txt
  4. Run the application

    python main.py

Usage

The complete documentation is in the README.md. In the programm, type "help" to get help (lol).