@agi-ventures-canada/hackathon-cli
v0.2.0
Published
CLI for the Oatmeal hackathon platform
Readme
@agi-ventures-canada/hackathon-cli
Run hackathons from your terminal. This is the command-line companion to Oatmeal — create events, manage teams, configure judging, pick winners, send announcements, and more.
Install
npm install -g @agi-ventures-canada/hackathon-cli
# or run once without installing
npx @agi-ventures-canada/hackathon-cli --helpRequires Node.js 20.9+.
Quick start
hackathon login
# Opens your browser, signs you in, creates an API key, saves it locally.
hackathon events list
hackathon events create # interactive prompts
hackathon prizes create <hackathon-id> --name "Best AI App"
hackathon announcements create <hackathon-id> --title "Kickoff in 1 hour" --body "See you soon"The API key is stored at ~/.hackathon/config.json — log in once, use it from anywhere.
Pointing at a different environment
hackathon login --base-url https://staging.getoatmeal.com
hackathon login --base-url http://localhost:3000
hackathon login # default: production (getoatmeal.com)The base URL is saved with the key, so commands work against whatever environment you logged in to.
Commands
Run hackathon --help for the full list. Highlights:
| Group | What it does |
|-------|--------------|
| events (alias: hackathons) | Create, list, update, and delete events. Import from Luma with --from-url. |
| judging | Manage judges, criteria, levels, assignments, and results |
| tracks | Prize tracks, round buckets, advancement rules |
| prizes | Create and assign prizes |
| perks | Sponsor credits, API keys, coupons — create, update, release |
| sponsors | Add sponsors, update tiers, reorder, remove |
| teams | List teams, create, update members, assign rooms |
| announcements | Publish immediately or schedule for later |
| challenges | Create sponsor or theme-based prompts |
| schedule | Event-scoped schedule items (kickoff, workshops, demos) |
| results | Calculate winners once judging closes |
| webhooks | Subscribe to event, team, and submission updates |
| jobs | Run, inspect, and cancel async jobs |
| schedules | Org-level cron jobs (different from event schedule) |
| browse | Discover public hackathons |
Most commands take a hackathon ID as the first positional arg:
hackathon prizes list <hackathon-id>
hackathon teams list <hackathon-id>
hackathon announcements publish <hackathon-id> <announcement-id>Add --json to any command for machine-readable output.
AI agents
Prefer driving the CLI through Claude Code, Cursor, or another AI agent? Install our public skills:
npx skills add AGI-Ventures-Canada/oatmealThat gives your agent two relevant skills: hackathon-cli (this package) and hackathon-api (direct HTTP calls).
Links
- Platform: https://getoatmeal.com
- Docs: https://getoatmeal.com/docs
- Source: https://github.com/AGI-Ventures-Canada/oatmeal (CLI lives in
packages/cli/) - Skills: https://github.com/AGI-Ventures-Canada/oatmeal/tree/main/skills
- Issues: https://github.com/AGI-Ventures-Canada/oatmeal/issues
License
MIT
