linear-sdk-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +9 -0
- package/CHANGELOG.md +807 -0
- package/COVERAGE.md +495 -0
- package/LICENSE +21 -0
- package/MIGRATING.md +220 -0
- package/README.md +524 -0
- package/package.json +87 -0
- package/skills/linear-sdk-cli/SKILL.md +534 -0
- package/skills/linear-sdk-cli/references/api.md +27 -0
- package/skills/linear-sdk-cli/references/attachment.md +82 -0
- package/skills/linear-sdk-cli/references/auth.md +174 -0
- package/skills/linear-sdk-cli/references/commands.md +37 -0
- package/skills/linear-sdk-cli/references/comment.md +154 -0
- package/skills/linear-sdk-cli/references/completion.md +17 -0
- package/skills/linear-sdk-cli/references/config.md +99 -0
- package/skills/linear-sdk-cli/references/cycle.md +131 -0
- package/skills/linear-sdk-cli/references/document.md +180 -0
- package/skills/linear-sdk-cli/references/favorite.md +78 -0
- package/skills/linear-sdk-cli/references/initiative-update.md +67 -0
- package/skills/linear-sdk-cli/references/initiative.md +256 -0
- package/skills/linear-sdk-cli/references/issue.md +928 -0
- package/skills/linear-sdk-cli/references/label.md +112 -0
- package/skills/linear-sdk-cli/references/milestone.md +139 -0
- package/skills/linear-sdk-cli/references/notification.md +123 -0
- package/skills/linear-sdk-cli/references/open.md +29 -0
- package/skills/linear-sdk-cli/references/organization.md +99 -0
- package/skills/linear-sdk-cli/references/project-update.md +67 -0
- package/skills/linear-sdk-cli/references/project.md +234 -0
- package/skills/linear-sdk-cli/references/roadmap.md +150 -0
- package/skills/linear-sdk-cli/references/schema.md +21 -0
- package/skills/linear-sdk-cli/references/state.md +61 -0
- package/skills/linear-sdk-cli/references/team.md +227 -0
- package/skills/linear-sdk-cli/references/user.md +103 -0
- package/skills/linear-sdk-cli/references/webhook.md +151 -0
- package/skills/linear-sdk-cli/references/whoami.md +26 -0
- package/skills/linear-sdk-cli/scripts/generate-docs.ts +339 -0
- package/src/bin/linear.ts +97 -0
- package/src/cli.ts +232 -0
- package/src/client.ts +172 -0
- package/src/commands/agent-session.ts +121 -0
- package/src/commands/api.ts +317 -0
- package/src/commands/attach.ts +90 -0
- package/src/commands/attachment.ts +74 -0
- package/src/commands/comment.ts +225 -0
- package/src/commands/completion.ts +69 -0
- package/src/commands/cycle.ts +125 -0
- package/src/commands/discover.ts +170 -0
- package/src/commands/document.ts +211 -0
- package/src/commands/favorite.ts +72 -0
- package/src/commands/initiative-update.ts +47 -0
- package/src/commands/initiative.ts +261 -0
- package/src/commands/issue.ts +1263 -0
- package/src/commands/label.ts +119 -0
- package/src/commands/meta.ts +534 -0
- package/src/commands/milestone.ts +163 -0
- package/src/commands/notification.ts +110 -0
- package/src/commands/open.ts +84 -0
- package/src/commands/organization.ts +79 -0
- package/src/commands/project-update.ts +47 -0
- package/src/commands/project.ts +339 -0
- package/src/commands/roadmap.ts +131 -0
- package/src/commands/state.ts +58 -0
- package/src/commands/team.ts +243 -0
- package/src/commands/user.ts +107 -0
- package/src/commands/webhook.ts +156 -0
- package/src/config.ts +1236 -0
- package/src/context.ts +117 -0
- package/src/git.ts +174 -0
- package/src/index.ts +10 -0
- package/src/lib/action.ts +26 -0
- package/src/lib/body.ts +172 -0
- package/src/lib/errors.ts +195 -0
- package/src/lib/introspect.ts +150 -0
- package/src/lib/keyring.ts +270 -0
- package/src/lib/mutation.ts +53 -0
- package/src/lib/open.ts +32 -0
- package/src/lib/options.ts +640 -0
- package/src/lib/output-shapes.ts +562 -0
- package/src/lib/pagination.ts +145 -0
- package/src/lib/prompt.ts +91 -0
- package/src/lib/resolve.ts +596 -0
- package/src/lib/shape.ts +273 -0
- package/src/lib/status-update.ts +91 -0
- package/src/lib/upload.ts +329 -0
- package/src/output/color.ts +52 -0
- package/src/output/format.ts +238 -0
- package/src/output/markdown.ts +133 -0
- package/src/output/pager.ts +131 -0
- package/src/output/sanitize.ts +76 -0
- package/src/output/table.ts +198 -0
- package/src/services/agent-session.ts +289 -0
- package/src/services/attachment.ts +198 -0
- package/src/services/comment.ts +262 -0
- package/src/services/cycle.ts +224 -0
- package/src/services/document.ts +357 -0
- package/src/services/favorite.ts +147 -0
- package/src/services/initiative-update.ts +59 -0
- package/src/services/initiative.ts +449 -0
- package/src/services/issue.ts +1153 -0
- package/src/services/label.ts +193 -0
- package/src/services/milestone.ts +262 -0
- package/src/services/notification.ts +190 -0
- package/src/services/organization.ts +144 -0
- package/src/services/project-update.ts +36 -0
- package/src/services/project.ts +494 -0
- package/src/services/roadmap.ts +177 -0
- package/src/services/state.ts +127 -0
- package/src/services/team.ts +386 -0
- package/src/services/user.ts +137 -0
- package/src/services/webhook.ts +203 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# linear auth
|
|
2
|
+
|
|
3
|
+
> Manage authentication
|
|
4
|
+
|
|
5
|
+
_Generated from `linear commands --json`. `linear auth --help` (or `<subcommand> --help`) is authoritative._
|
|
6
|
+
|
|
7
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
8
|
+
|
|
9
|
+
### `linear auth`
|
|
10
|
+
|
|
11
|
+
Manage authentication
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
linear auth [options]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### `linear auth adopt`
|
|
18
|
+
|
|
19
|
+
Adopt an existing named credential from the shared OS keyring
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
linear auth adopt [options] <slug>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Output (`--json`)**: a receipt object
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
success: boolean
|
|
29
|
+
workspace: string
|
|
30
|
+
user: {id: string, name: string, email: string}
|
|
31
|
+
storage: string
|
|
32
|
+
path: string
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### `linear auth default`
|
|
36
|
+
|
|
37
|
+
Set the default workspace credential
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
linear auth default [options] <slug>
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Output (`--json`)**: a receipt object
|
|
44
|
+
|
|
45
|
+
```text
|
|
46
|
+
success: boolean
|
|
47
|
+
default_workspace: string
|
|
48
|
+
path: string
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### `linear auth list`
|
|
52
|
+
|
|
53
|
+
List configured workspace credentials
|
|
54
|
+
|
|
55
|
+
Aliases: `ls`
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
linear auth list [options]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Output (`--json`)**: a bare array of objects
|
|
62
|
+
|
|
63
|
+
```text
|
|
64
|
+
slug: string
|
|
65
|
+
isDefault: boolean
|
|
66
|
+
storage: string
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `linear auth login`
|
|
70
|
+
|
|
71
|
+
Validate and store a Linear API key for a workspace
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
linear auth login [options]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
| Option | Description |
|
|
78
|
+
| ------------- | --------------------------------------------------------------------- |
|
|
79
|
+
| `--key <key>` | API key (otherwise prompted; '-' reads it from stdin) |
|
|
80
|
+
| `--plaintext` | Store the key in the config file (0600) instead of the system keyring |
|
|
81
|
+
|
|
82
|
+
**Output (`--json`)**: a receipt object
|
|
83
|
+
|
|
84
|
+
```text
|
|
85
|
+
success: boolean
|
|
86
|
+
workspace: string
|
|
87
|
+
user: {id: string, name: string, email: string}
|
|
88
|
+
storage: string
|
|
89
|
+
path: string
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### `linear auth logout`
|
|
93
|
+
|
|
94
|
+
Remove a stored workspace credential (select with --workspace <slug>)
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
linear auth logout [options]
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Output (`--json`)**: a receipt object
|
|
101
|
+
|
|
102
|
+
```text
|
|
103
|
+
success: boolean
|
|
104
|
+
workspace: string
|
|
105
|
+
removed: boolean
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### `linear auth migrate`
|
|
109
|
+
|
|
110
|
+
Move plaintext credentials from the config file into the system keyring
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
linear auth migrate [options]
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
**Output (`--json`)**: a receipt object
|
|
117
|
+
|
|
118
|
+
```text
|
|
119
|
+
success: boolean
|
|
120
|
+
migrated: string[]
|
|
121
|
+
path: string
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### `linear auth status`
|
|
125
|
+
|
|
126
|
+
Show where the API key is resolved from (key redacted)
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
linear auth status [options]
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Output (`--json`)**: a bare object
|
|
133
|
+
|
|
134
|
+
```text
|
|
135
|
+
authenticated: boolean
|
|
136
|
+
source: string
|
|
137
|
+
workspace: string | null
|
|
138
|
+
key: string
|
|
139
|
+
keyring: string | null
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### `linear auth token`
|
|
143
|
+
|
|
144
|
+
Print the resolved API key for the active workspace (for scripting)
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
linear auth token [options]
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**Output (`--json`)**: a bare object
|
|
151
|
+
|
|
152
|
+
```text
|
|
153
|
+
apiKey: string
|
|
154
|
+
workspace: string | null
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### `linear auth whoami`
|
|
158
|
+
|
|
159
|
+
Show the authenticated user
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
linear auth whoami [options]
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
**Output (`--json`)**: a bare object
|
|
166
|
+
|
|
167
|
+
```text
|
|
168
|
+
id: string
|
|
169
|
+
name: string
|
|
170
|
+
displayName: string
|
|
171
|
+
email: string
|
|
172
|
+
admin: boolean
|
|
173
|
+
organization: {id: string, name: string, urlKey: string}
|
|
174
|
+
```
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# linear commands
|
|
2
|
+
|
|
3
|
+
> List every command in a machine-readable tree, or describe one (for scripts/agents)
|
|
4
|
+
|
|
5
|
+
_Generated from `linear commands --json`. `linear commands --help` (or `<subcommand> --help`) is authoritative._
|
|
6
|
+
|
|
7
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
8
|
+
|
|
9
|
+
### `linear commands`
|
|
10
|
+
|
|
11
|
+
List every command in a machine-readable tree, or describe one (for scripts/agents)
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
linear commands [options] [path...]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Output (`--json`)**: a bare array of objects — `output` is absent on a group that only holds subcommands
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
path: string
|
|
21
|
+
description: string
|
|
22
|
+
aliases: string[]
|
|
23
|
+
arguments: Array<{name: string, required: boolean, variadic: boolean}>
|
|
24
|
+
options: Array<{flags: string, description: string, attribute: string, valueRequired: boolean, valueOptional: boolean, variadic: boolean, choices?: string[], defaultValue?: unknown, global: boolean, applicable: boolean}>
|
|
25
|
+
output?: {kind: string, fields?: object, note?: string, variants?: object}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
With `[path]`: a bare object
|
|
29
|
+
|
|
30
|
+
```text
|
|
31
|
+
path: string
|
|
32
|
+
description: string
|
|
33
|
+
aliases: string[]
|
|
34
|
+
arguments: Array<{name: string, required: boolean, variadic: boolean}>
|
|
35
|
+
options: Array<{flags: string, description: string, attribute: string, valueRequired: boolean, valueOptional: boolean, variadic: boolean, choices?: string[], defaultValue?: unknown, global: boolean, applicable: boolean}>
|
|
36
|
+
output?: {kind: string, fields?: object, note?: string, variants?: object}
|
|
37
|
+
```
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# linear comment
|
|
2
|
+
|
|
3
|
+
> Manage comments
|
|
4
|
+
|
|
5
|
+
Group alias: `cm`
|
|
6
|
+
|
|
7
|
+
_Generated from `linear commands --json`. `linear comment --help` (or `<subcommand> --help`) is authoritative._
|
|
8
|
+
|
|
9
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
10
|
+
|
|
11
|
+
### `linear comment`
|
|
12
|
+
|
|
13
|
+
Manage comments
|
|
14
|
+
|
|
15
|
+
Aliases: `cm`
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
linear comment [options]
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### `linear comment add`
|
|
22
|
+
|
|
23
|
+
Add a comment to an issue (images uploaded with --attach render inline)
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
linear comment add [options] <issue> [body]
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
| Option | Description |
|
|
30
|
+
| -------------------- | ----------------------------------------------------------------------------------------- |
|
|
31
|
+
| `--body-file <path>` | read comment body from a file ('-' = stdin) |
|
|
32
|
+
| `--attach <file>` | upload a file and embed it in the comment (images inline; repeatable; private by default) |
|
|
33
|
+
| `--public` | upload the attachments to public, world-readable URLs (raster images only) |
|
|
34
|
+
|
|
35
|
+
**Output (`--json`)**: a receipt object — `attachments` only with --attach
|
|
36
|
+
|
|
37
|
+
```text
|
|
38
|
+
id: string
|
|
39
|
+
issue: string
|
|
40
|
+
url: string
|
|
41
|
+
attachments?: Array<{filename: string, assetUrl: string, contentType: string, size: number}>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### `linear comment delete`
|
|
45
|
+
|
|
46
|
+
Delete a comment
|
|
47
|
+
|
|
48
|
+
Aliases: `rm`
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
linear comment delete [options] <commentId>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Output (`--json`)**: a receipt object
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
id: string
|
|
58
|
+
deleted: boolean
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### `linear comment list`
|
|
62
|
+
|
|
63
|
+
List comments on an issue
|
|
64
|
+
|
|
65
|
+
Aliases: `ls`
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
linear comment list [options] <issue>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
**Output (`--json`)**: a bare array of objects
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
id: string
|
|
75
|
+
body: string
|
|
76
|
+
user: {id: string, displayName: string} | null
|
|
77
|
+
createdAt: string
|
|
78
|
+
editedAt: string | null
|
|
79
|
+
resolvedAt: string | null
|
|
80
|
+
parent: {id: string} | null
|
|
81
|
+
url: string
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### `linear comment reply`
|
|
85
|
+
|
|
86
|
+
Reply to a comment (nested under it)
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
linear comment reply [options] <commentId> [body]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
| Option | Description |
|
|
93
|
+
| -------------------- | ----------------------------------------- |
|
|
94
|
+
| `--body-file <path>` | read reply body from a file ('-' = stdin) |
|
|
95
|
+
|
|
96
|
+
**Output (`--json`)**: a receipt object
|
|
97
|
+
|
|
98
|
+
```text
|
|
99
|
+
id: string
|
|
100
|
+
parent: string
|
|
101
|
+
issue: string | null
|
|
102
|
+
url: string
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### `linear comment resolve`
|
|
106
|
+
|
|
107
|
+
Resolve a comment thread
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
linear comment resolve [options] <commentId>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
**Output (`--json`)**: a receipt object
|
|
114
|
+
|
|
115
|
+
```text
|
|
116
|
+
id: string
|
|
117
|
+
resolved: boolean
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### `linear comment unresolve`
|
|
121
|
+
|
|
122
|
+
Unresolve a comment thread
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
linear comment unresolve [options] <commentId>
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**Output (`--json`)**: a receipt object
|
|
129
|
+
|
|
130
|
+
```text
|
|
131
|
+
id: string
|
|
132
|
+
resolved: boolean
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### `linear comment update`
|
|
136
|
+
|
|
137
|
+
Update a comment's body
|
|
138
|
+
|
|
139
|
+
Aliases: `edit`
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
linear comment update [options] <commentId> [body]
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
| Option | Description |
|
|
146
|
+
| -------------------- | --------------------------------------- |
|
|
147
|
+
| `--body-file <path>` | read new body from a file ('-' = stdin) |
|
|
148
|
+
|
|
149
|
+
**Output (`--json`)**: a receipt object
|
|
150
|
+
|
|
151
|
+
```text
|
|
152
|
+
id: string
|
|
153
|
+
url: string
|
|
154
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# linear completion
|
|
2
|
+
|
|
3
|
+
> Output a shell completion script (bash|zsh|fish)
|
|
4
|
+
|
|
5
|
+
_Generated from `linear commands --json`. `linear completion --help` (or `<subcommand> --help`) is authoritative._
|
|
6
|
+
|
|
7
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
8
|
+
|
|
9
|
+
### `linear completion`
|
|
10
|
+
|
|
11
|
+
Output a shell completion script (bash|zsh|fish)
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
linear completion [options] <shell>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Output (`--json`)**: none — never prints JSON — always prints a shell script; --json has no effect
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# linear config
|
|
2
|
+
|
|
3
|
+
> Show the resolved configuration, or write a project config
|
|
4
|
+
|
|
5
|
+
_Generated from `linear commands --json`. `linear config --help` (or `<subcommand> --help`) is authoritative._
|
|
6
|
+
|
|
7
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
8
|
+
|
|
9
|
+
### `linear config`
|
|
10
|
+
|
|
11
|
+
Show the resolved configuration, or write a project config
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
linear config [options]
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**Output (`--json`)**: a bare object — runs `config show` by default
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
apiKey: string
|
|
21
|
+
apiKeySource: string
|
|
22
|
+
credentialWorkspace: string | null
|
|
23
|
+
team: string | null
|
|
24
|
+
workspace: string | null
|
|
25
|
+
sort: string
|
|
26
|
+
origins: {team: {source: string, path?: string, key?: string}, workspace: {source: string, path?: string, key?: string}, sort: {source: string, path?: string, key?: string}}
|
|
27
|
+
userConfigPath: string
|
|
28
|
+
projectConfigPath: string | null
|
|
29
|
+
globalConfigPath: string | null
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### `linear config init`
|
|
33
|
+
|
|
34
|
+
Write a project .linear.toml (at the git root, or here outside a repository)
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
linear config init [options]
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
| Option | Description |
|
|
41
|
+
| ---------------- | ------------------------------------------------------------------ |
|
|
42
|
+
| `--team <key>` | default team key (otherwise chosen from a list) |
|
|
43
|
+
| `--sort <order>` | default issue-list sort (priority \| manual \| updated \| created) |
|
|
44
|
+
| `--path <file>` | write this file instead of <git root>/.linear.toml |
|
|
45
|
+
| `--force` | overwrite an existing file |
|
|
46
|
+
|
|
47
|
+
**Output (`--json`)**: a receipt object
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
success: boolean
|
|
51
|
+
path: string
|
|
52
|
+
team: string
|
|
53
|
+
sort?: string
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### `linear config set`
|
|
57
|
+
|
|
58
|
+
Set one project setting (team, workspace, sort) in the project config
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
linear config set [options] <key> <value>
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
| Option | Description |
|
|
65
|
+
| --------------- | ------------------------------------------------------------ |
|
|
66
|
+
| `--user` | write the user config (~/.config/linear/config.toml) instead |
|
|
67
|
+
| `--path <file>` | write this file instead of the project config in effect |
|
|
68
|
+
|
|
69
|
+
**Output (`--json`)**: a receipt object
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
success: boolean
|
|
73
|
+
path: string
|
|
74
|
+
key: string
|
|
75
|
+
value: string
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### `linear config show`
|
|
79
|
+
|
|
80
|
+
Show the resolved configuration and where each value came from (secrets redacted)
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
linear config show [options]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
**Output (`--json`)**: a bare object
|
|
87
|
+
|
|
88
|
+
```text
|
|
89
|
+
apiKey: string
|
|
90
|
+
apiKeySource: string
|
|
91
|
+
credentialWorkspace: string | null
|
|
92
|
+
team: string | null
|
|
93
|
+
workspace: string | null
|
|
94
|
+
sort: string
|
|
95
|
+
origins: {team: {source: string, path?: string, key?: string}, workspace: {source: string, path?: string, key?: string}, sort: {source: string, path?: string, key?: string}}
|
|
96
|
+
userConfigPath: string
|
|
97
|
+
projectConfigPath: string | null
|
|
98
|
+
globalConfigPath: string | null
|
|
99
|
+
```
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# linear cycle
|
|
2
|
+
|
|
3
|
+
> Work with cycles
|
|
4
|
+
|
|
5
|
+
Group alias: `c`
|
|
6
|
+
|
|
7
|
+
_Generated from `linear commands --json`. `linear cycle --help` (or `<subcommand> --help`) is authoritative._
|
|
8
|
+
|
|
9
|
+
Every command also accepts the global flags `-j/--json`, `--no-input`, `-y/--yes`, `-q/--quiet`, `--workspace <slug>`, `--api-key <key>`, `-t/--team <key>`, `-n/--limit <n>`, `--all`, `-f/--fields <a,b,c>`, `--no-ansi` (alias `--no-color`), and `--debug`. Only command-specific options are listed below.
|
|
10
|
+
|
|
11
|
+
### `linear cycle`
|
|
12
|
+
|
|
13
|
+
Work with cycles
|
|
14
|
+
|
|
15
|
+
Aliases: `c`
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
linear cycle [options]
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### `linear cycle create`
|
|
22
|
+
|
|
23
|
+
Create a cycle
|
|
24
|
+
|
|
25
|
+
Aliases: `new`
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
linear cycle create [options] [team]
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
| Option | Description |
|
|
32
|
+
| ---------------- | -------------------------------------- |
|
|
33
|
+
| `--start <date>` | start date/time (ISO, e.g. 2026-07-01) |
|
|
34
|
+
| `--end <date>` | end date/time (ISO, e.g. 2026-07-14) |
|
|
35
|
+
| `--name <name>` | custom cycle name |
|
|
36
|
+
|
|
37
|
+
**Output (`--json`)**: a receipt object
|
|
38
|
+
|
|
39
|
+
```text
|
|
40
|
+
id: string
|
|
41
|
+
number: number
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### `linear cycle current`
|
|
45
|
+
|
|
46
|
+
Show the team's currently active cycle
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
linear cycle current [options] [team]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**Output (`--json`)**: a bare object
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
id: string
|
|
56
|
+
number: number
|
|
57
|
+
name: string | null
|
|
58
|
+
description: string | null
|
|
59
|
+
startsAt: string
|
|
60
|
+
endsAt: string
|
|
61
|
+
completedAt: string | null
|
|
62
|
+
progress: number
|
|
63
|
+
team: string | null
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### `linear cycle list`
|
|
67
|
+
|
|
68
|
+
List cycles for a team (defaults to the configured team)
|
|
69
|
+
|
|
70
|
+
Aliases: `ls`
|
|
71
|
+
|
|
72
|
+
```
|
|
73
|
+
linear cycle list [options] [team]
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Output (`--json`)**: a bare array of objects
|
|
77
|
+
|
|
78
|
+
```text
|
|
79
|
+
id: string
|
|
80
|
+
number: number
|
|
81
|
+
name: string | null
|
|
82
|
+
startsAt: string
|
|
83
|
+
endsAt: string
|
|
84
|
+
progress: number
|
|
85
|
+
completedAt: string | null
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### `linear cycle update`
|
|
89
|
+
|
|
90
|
+
Update a cycle (by id, number, or 'current')
|
|
91
|
+
|
|
92
|
+
Aliases: `edit`
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
linear cycle update [options] <id>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
| Option | Description |
|
|
99
|
+
| ---------------- | --------------------- |
|
|
100
|
+
| `--name <name>` | custom cycle name |
|
|
101
|
+
| `--start <date>` | start date/time (ISO) |
|
|
102
|
+
| `--end <date>` | end date/time (ISO) |
|
|
103
|
+
|
|
104
|
+
**Output (`--json`)**: a receipt object
|
|
105
|
+
|
|
106
|
+
```text
|
|
107
|
+
id: string
|
|
108
|
+
number: number
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### `linear cycle view`
|
|
112
|
+
|
|
113
|
+
Show a cycle (by id, number, or 'current')
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
linear cycle view [options] <id>
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**Output (`--json`)**: a bare object
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
id: string
|
|
123
|
+
number: number
|
|
124
|
+
name: string | null
|
|
125
|
+
description: string | null
|
|
126
|
+
startsAt: string
|
|
127
|
+
endsAt: string
|
|
128
|
+
completedAt: string | null
|
|
129
|
+
progress: number
|
|
130
|
+
team: string | null
|
|
131
|
+
```
|