Module: ShapeupCli::Commands

Defined in:
lib/shapeup_cli/commands.rb,
lib/shapeup_cli/commands/auth.rb,
lib/shapeup_cli/commands/base.rb,
lib/shapeup_cli/commands/orgs.rb,
lib/shapeup_cli/commands/tags.rb,
lib/shapeup_cli/commands/cycle.rb,
lib/shapeup_cli/commands/login.rb,
lib/shapeup_cli/commands/setup.rb,
lib/shapeup_cli/commands/tasks.rb,
lib/shapeup_cli/commands/issues.rb,
lib/shapeup_cli/commands/logout.rb,
lib/shapeup_cli/commands/scopes.rb,
lib/shapeup_cli/commands/search.rb,
lib/shapeup_cli/commands/my_work.rb,
lib/shapeup_cli/commands/pitches.rb,
lib/shapeup_cli/commands/comments.rb,
lib/shapeup_cli/commands/checklist.rb,
lib/shapeup_cli/commands/config_cmd.rb

Defined Under Namespace

Classes: Auth, Base, Checklist, Comments, ConfigCmd, Cycle, Issues, Login, Logout, MyWork, Orgs, Pitches, Scopes, Search, Setup, Tags, Tasks

Class Method Summary collapse

Class Method Details

.help ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/shapeup_cli/commands.rb', line 5

def self.help
  puts <<~HELP
    ShapeUp CLI — Manage pitches, scopes, tasks, and cycles from the terminal.

    Usage: shapeup <command> [options]

    Auth:
      login                     Authenticate via OAuth (creates a profile)
      logout                    Clear all credentials
      auth status               Check authentication status
      auth list                 List configured profiles
      auth switch <name>        Switch active profile
      auth remove <name>        Remove a profile

    Discovery:
      orgs                      List your organisations
      commands                  List all available commands

    Pitches:
      pitches list              List pitches (packages)
      pitches show <id>         Show pitch details with scopes and tasks
      pitch <id>                Shortcut for pitches show

    Cycles:
      cycles                    List all cycles
      cycle show <id>           Show cycle details with pitches and progress

    Scopes:
      scopes list --pitch <id>  List scopes for a pitch
      scopes create --pitch <id> "Title"
      scopes update <id> --title "New title"

    Tasks:
      tasks list --scope <id>   List tasks for a scope
      todo "Description" --pitch <id> [--scope <id>]
      done <id> [<id>...]       Mark task(s) as complete

    Issues:
      issues                    List open issues
      issues --all              Include done/closed
      issues --column triage    Filter by column name
      issues --assignee me      Issues assigned to me
      issues --assignee none    Unassigned issues
      issues --tag seo          Filter by tag
      issues --stream "Name"    Filter by stream name
      issues --kind bug         Filter by kind (bug/request)
      issue <id>                Show issue details
      issues create "Title" --stream "Name" [--content "..."]
      issues move <id> --column doing
      issues done <id>          Mark issue as done
      issues close <id>         Close issue (won't fix)
      issues reopen <id>        Reopen a done/closed issue
      issues icebox <id>        Move to icebox
      issues defrost <id>       Restore from icebox
      issues assign <id>        Assign yourself (or --user <id>)
      issues unassign <id>      Unassign yourself (or --user <id>)
      issues watch <id>         Watch an issue
      issues unwatch <id>       Stop watching
      watching                  List issues you are watching
      issues delete <id>        Delete an issue
      issues convert <id>       Convert issue to a new pitch
      issues add-to-pitch <id> --pitch <pid>
                                Fold issue into an existing pitch

    Comments:
      comments list --issue <id>           List comments on an issue
      comments list --pitch <id>           List comments on a pitch
      comments add --issue <id> "Text"     Add a comment to an issue
      comments add --pitch <id> "Text"     Add a comment to a pitch

    Checklist:
      checklist --pitch <id>               List the checklist on a pitch
      checklist --issue <id>               List the checklist on an issue
      checklist add --pitch <id> "Text"    Add an item
      checklist tick <item_id>             Mark an item complete
      checklist untick <item_id>           Mark an item incomplete
      checklist edit <item_id> "Text"      Rename an item
      checklist remove <item_id>           Delete an item

    Tags:
      tags                                 List the org's tag vocabulary
      tags add --pitch <id> <name>         Tag a pitch
      tags add --issue <id> <name>         Tag an issue
      tags remove --pitch <id> <name>      Untag a pitch
      tags remove --issue <id> <name>      Untag an issue

    My Work:
      my-work, me               Show everything assigned to me

    Search:
      search "query"            Search across pitches, scopes, tasks, issues

    Config:
      config show               Show current config
      config set org "Name"     Set default organisation (name or ID)
      config set host <url>     Set ShapeUp host
      config init "Name"        Create .shapeup/config.json for this directory

    Setup:
      setup claude              Install skill into Claude Code
      setup cursor              Install skill into Cursor
      setup project             Install skill into current project

    Output modes (append to any command):
      --json                    Full JSON envelope with breadcrumbs
      --md                      Markdown tables
      --agent                   Raw JSON data only (for AI agents)
      --quiet, -q               Same as --agent
      --ids-only                Print only IDs (one per line)
      (piped output auto-switches to --json)

    Flags:
      --org <id|name>           Override default organisation
      --host <url>              Override ShapeUp host (default: https://shapeup.cc)

    Environment variables:
      SHAPEUP_TOKEN             Bearer token (skips OAuth, for CI/scripts)
      SHAPEUP_ORG               Default organisation ID
      SHAPEUP_HOST              API host URL

    Examples:
      shapeup login
      shapeup config set org "Compass Labs"
      shapeup pitches list --json
      shapeup pitch 42
      shapeup todo "Fix login bug" --pitch 42 --scope 7
      shapeup done 123 124 125
      shapeup me --md
  HELP
end

.list_commands ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/shapeup_cli/commands.rb', line 136

def self.list_commands
  puts <<~COMMANDS
    login          Authenticate (creates a profile)
    logout         Clear all credentials
    auth           Manage profiles (status, list, switch, remove)
    orgs           List organisations
    pitches        List/show pitches (list, show)
    pitch          Show a pitch (shortcut)
    cycles         List cycles
    cycle          Show cycle details (list, show)
    scopes         Manage scopes (list, create, update)
    tasks          Manage tasks (list, create, complete)
    todo           Create a task (shortcut)
    done           Complete task(s) (shortcut)
    issues         Manage issues (list, show, create, move, icebox, watch, convert, add-to-pitch)
    issue          Show an issue (shortcut)
    watching       List watched issues (shortcut)
    comments       List and add comments (list, add)
    checklist      Manage checklist items on pitches/issues (list, add, tick, untick, edit, remove)
    tags           List/add/remove tags on pitches and issues
    my-work / me   Show my assigned work
    search         Search everything
    config         Show/set config (set, show, init)
    setup          Install agent skills (claude, cursor, project)
    commands       This list
    help           Usage guide
    version        Show version
  COMMANDS
end