Skip to content

Commit ce520f7

Browse files
committed
docs: enhance CLI help text and examples
- Clarify project assignment supports both names and IDs - Improve label filtering help text for multi-team functionality - Add better examples showcasing new project assignment features - Enhance project creation help with clearer team association description - Add more comprehensive usage examples for all new commands
1 parent ed14754 commit ce520f7

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

src/linear_cli/cli/commands/issue.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ async def fetch_issues() -> dict[str, Any]:
133133
help="Issue priority (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)",
134134
)
135135
@click.option("--labels", "-L", help="Label names (comma-separated)")
136-
@click.option("--project", help="Project name or ID to assign the issue to")
136+
@click.option("--project", help="Project name or ID to assign the issue to (supports both names and IDs)")
137137
@click.pass_context
138138
def create(
139139
ctx: click.Context,
@@ -157,6 +157,7 @@ def create(
157157
linear-cli issue create "Bug fix" --team ENG --assignee jane@example.com --priority 3
158158
linear-cli issue create "Enhancement" --labels "feature,ui" --description "Improve UX"
159159
linear-cli issue create "Database migration" --project "Q4 Backend Work" --team ENG
160+
linear-cli issue create "API refactor" --project "Backend Improvements" --priority 2
160161
"""
161162
cli_ctx = ctx.obj["cli_context"]
162163
client = cli_ctx.get_client()
@@ -328,7 +329,7 @@ async def fetch_issue() -> dict[str, Any] | None:
328329
help="New issue priority (0=None, 1=Low, 2=Normal, 3=High, 4=Urgent)",
329330
)
330331
@click.option("--labels", "-L", help="New labels (comma-separated, replaces existing)")
331-
@click.option("--project", help="Project name or ID to assign the issue to")
332+
@click.option("--project", help="Project name or ID to assign the issue to (supports both names and IDs)")
332333
@click.pass_context
333334
def update(
334335
ctx: click.Context,
@@ -353,6 +354,7 @@ def update(
353354
linear-cli issue update ENG-123 --priority 4 --labels "bug,critical"
354355
linear-cli issue update ENG-123 --description "Updated description"
355356
linear-cli issue update ENG-123 --project "Backend Improvements"
357+
linear-cli issue update ENG-123 --project "Q4 Sprint" --priority 3
356358
"""
357359
cli_ctx = ctx.obj["cli_context"]
358360
client = cli_ctx.get_client()

src/linear_cli/cli/commands/label.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ def label_group() -> None:
3232
"--team",
3333
"-t",
3434
multiple=True,
35-
help="Team key or ID to filter by (can be used multiple times)",
35+
help="Team key or ID to filter by (can be used multiple times for specific teams)",
3636
)
37-
@click.option("--all-teams", is_flag=True, help="Show labels from all accessible teams")
37+
@click.option("--all-teams", is_flag=True, help="Show labels from all accessible teams at once")
3838
@click.option(
3939
"--limit",
4040
"-l",
@@ -55,9 +55,10 @@ def list(
5555
5656
Examples:
5757
linear-cli label list # Labels from default team
58-
linear-cli label list --team ENG # Labels from ENG team
59-
linear-cli label list --team ENG --team QA # Labels from ENG and QA teams
58+
linear-cli label list --team ENG # Labels from ENG team only
59+
linear-cli label list --team ENG --team QA # Labels from both ENG and QA teams
6060
linear-cli label list --all-teams # Labels from all accessible teams
61+
linear-cli label list --all-teams --limit 50 # Limit labels per team
6162
"""
6263
cli_ctx = ctx.obj["cli_context"]
6364
client = cli_ctx.get_client()

src/linear_cli/cli/commands/project.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@ async def create_update() -> dict[str, Any]:
144144
@click.argument("name")
145145
@click.option("--description", "-d", help="Project description")
146146
@click.option(
147-
"--team", "-t", multiple=True, help="Team key or ID (can be used multiple times)"
147+
"--team", "-t", multiple=True, help="Team key or ID to associate with project (can be used multiple times)"
148148
)
149-
@click.option("--lead", help="Project lead email or ID")
149+
@click.option("--lead", help="Project lead email or ID (user who manages the project)")
150150
@click.option(
151151
"--state",
152152
type=click.Choice(["planned", "started", "paused", "completed", "canceled"]),
@@ -177,6 +177,7 @@ def create(
177177
linear project create "Feature X" --description "New feature development"
178178
linear project create "Bug Fixes" --team ENG --team QA --lead john@example.com
179179
linear project create "Q4 Initiative" --state started --target-date 2024-12-31
180+
linear project create "Mobile App" --team ENG --team DESIGN --description "iOS/Android app"
180181
"""
181182
cli_ctx = ctx.obj["cli_context"]
182183
client = cli_ctx.get_client()

0 commit comments

Comments
 (0)