Skip to content

pikarama/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pikarama CLI

Command-line interface for Pikarama — karma-weighted group decisions.

✨ Interactive by default — run commands without arguments and get beautiful select menus. Add --json for scripts.

Install

npm install -g @pikarama/cli

Quick start

# Interactive login
pikarama login

# Browse and select events interactively
pikarama events

# Create a poll with guided prompts
pikarama poll

# Or use non-interactive mode for scripts
pikarama events --json
pikarama poll <topic-id> "Question?" --option "A" --option "B" --json

Features

  • 🎨 Interactive mode — Select from menus, get prompted for missing info
  • 📦 JSON mode--json flag for scripting and automation
  • 🔇 Quiet mode--quiet for minimal output (just IDs)

Commands

Events

pikarama events                    # Interactive: browse and select
pikarama events --json             # List as JSON
pikarama events create             # Interactive: guided creation
pikarama events submit             # Interactive: select event, enter pick
pikarama events vote               # Interactive: select event & submission
pikarama events advance <id>       # Advance to next phase

Polls

pikarama poll                      # Interactive: full guided flow
pikarama poll <topic> "Q?" -o A -o B   # Non-interactive

Groups

pikarama groups                    # Interactive: browse groups
pikarama groups create             # Interactive: create with prompts
pikarama groups join               # Interactive: enter invite code

Karma

pikarama karma                     # Show karma across all topics
pikarama karma <group-id>          # Filter by group

Schedules

pikarama schedules list <group-id> --json
pikarama schedules create <group-id> \
  --topic <topic-id> \
  --name "Friday Lunch" \
  --rrule "FREQ=WEEKLY;BYDAY=FR;BYHOUR=12;BYMINUTE=0;BYSECOND=0" \
  --timezone Europe/Prague \
  --json
pikarama schedules delete <group-id> <schedule-id>

Auth

pikarama login                     # Store API token
pikarama logout                    # Remove token

Output modes

Flag Effect
(default) Interactive menus and prompts
--json Raw JSON (non-interactive)
--quiet Minimal output, just IDs

Configuration

API

REST API: https://www.pikarama.com/api/v1
OpenAPI docs: https://www.pikarama.com/api-docs

License

MIT

About

Command-line interface for Pikarama - manage groups, events, and polls from your terminal

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors