Shipwrecked API

CLI Toolkit

Command-line tools for interacting with the Shipwrecked API, including authentication, vessel management, and trip operations.

🛠️ Core CLI Commands

Authentication

# Authenticate with API key
shipwreck login --api-key YOUR_API_KEY

# Or authenticate using OAuth
shipwreck auth --client-id YOUR_CLIENT_ID \
              --client-secret YOUR_CLIENT_SECRET \
              --grant-type client_credentials

Initialize authentication session. Tokens are cached automatically with expiry tracking.

Vessel Operations

shipwreck vessels list --filter active

List all active vessels with real-time location and status.

shipwreck vessels show ID --details

Retrieve detailed information about a specific vessel including fuel and maintenance status.

Trip Management

shipwreck trips create \
  --vessel V12345 \
  --from Seattle \
  --to Tokyo \
  --departure-time 2025-09-01T08:00:00Z

Schedule a new vessel trip with specified origin, destination, and departure time.

shipwreck trips list \
  --vessel V12345 \
  --status active

List active trips for a specific vessel with route details and current status.

Fuel Analytics

shipwreck fuel forecast \
  --vessel V12345 \
  --days 7 \
  --format table

Generate a weekly fuel consumption forecast displayed in an interactive table format.

```