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.
- Complete Account Management: View and manage your Shipwrecked profile
- Progress Tracking: Monitor your journey to the island
- Shop Integration: Browse items, place orders, and manage inventory
- Leaderboard Access: Check rankings and competition stats
- Session Management: Handle authentication and user sessions
- Interactive CLI: User-friendly command-line interface with help system
-
Clone the repository
git clone https://github.com/LennyMaxMine/shipwreckedcli cd ShipwreckedCli -
Create a virtual environment
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
-
Install dependencies
pip install -r requirements.txt
-
Run the application
python main.py
| Command | Description |
|---|---|
help |
Show the main help message |
ls |
Show all submenus |
whoami |
Display your user profile data |
session |
Show current session information |
progress |
View your progress toward the island |
leaderboard |
Display leaderboard sorted by hours |
logut |
Delete all your locally stored account data |
fetch |
Fetch your ShipwreckedCli information |
cd |
Enter the selected submenu |
Access the shop with the cd shop command, then use:
| Command | Description |
|---|---|
items |
Browse available shop items |
purchase |
Buy a shop item (under development) |
orders |
View your order history |
inventory |
Check your fulfilled orders |
back |
Return to main menu |
cd .. |
Return to main menu |
Access user settings with the cd user command, then use:
| Command | Description |
|---|---|
name |
Display your name |
email |
Show your email address |
address |
View your address |
birthday |
Display your birthday |
phone |
Show your phone number |
id |
Print your user ID |
email-verification |
Check email verification status |
identity-verification |
Check identity verification status |
slack-connected |
Show Slack connection status |
back |
Return to main menu |
cd .. |
Return to main menu |
Access the projects submenu with the cd projects command, then use:
| Command | Description |
|---|---|
list |
Display all your projects |
details |
View detailed project information |
reviews |
View Project reviews |
stats |
Show project statistics |
back |
Return to main menu |
cd .. |
Return to main menu |
Access the gallery submenu with the cd gallery command, then use:
| Command | Description |
|---|---|
list |
View all gallery projects |
details |
View detailed project information |
upvote |
Upvote a project |
popular |
View projects sorted by upvotes |
recent |
View projects by most recent chat activity |
search |
Search projects by name or description |
stats |
Show gallery statistics |
back |
Exit back to main program |
cd .. |
Return to main menu |
| Command | Description |
|---|---|
exit |
Exit the application |
clear |
Clear the screen |
- Use
helpfor general commands - Use
help(e.g.,nu> help shop) for submenu-specific commands - Commands are available context-sensitively based on your current menu
This project is actively developed for the 2025 Hack Club Shipwrecked Hackathon. Some features like shop purchases are still under construction.
- Python 3.7+
- Dependencies listed in
requirements.txt - Valid Shipwrecked account credentials
This project is licensed under the MIT License. See the LICENSE file (which will be added later :D) for details.
Developed with ♥ by LennyMaxMine in Frankfurt, Germany for the 2025 Hack Club Shipwrecked Hackathon.