linear-sdk-cli 0.8.3 → 0.9.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.
@@ -0,0 +1,148 @@
1
+ # linear release-note
2
+
3
+ > Manage Markdown notes covering one or more releases
4
+
5
+ _Generated from `linear commands --json`. `linear release-note --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>`, `--access-token <token>`, `-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 release-note`
10
+
11
+ Manage Markdown notes covering one or more releases
12
+
13
+ ```
14
+ linear release-note [options]
15
+ ```
16
+
17
+ ### `linear release-note create`
18
+
19
+ Create a note for explicit releases or an inclusive createdAt range
20
+
21
+ ```
22
+ linear release-note create [options]
23
+ ```
24
+
25
+ | Option | Description |
26
+ | ----------------------- | ---------------------------------------------- |
27
+ | `--title <title>` | release note title |
28
+ | `--body <text>` | release note body (Markdown) |
29
+ | `--body-file <path>` | read Markdown from file ('-' for stdin) |
30
+ | `--release <id>` | covered release UUID or slug (repeatable) |
31
+ | `--from-release <id>` | oldest release in an inclusive createdAt range |
32
+ | `--to-release <id>` | newest release in the inclusive range |
33
+ | `--pipeline <id\|slug>` | pipeline UUID or slug |
34
+
35
+ **Output (`--json`)**: a receipt object
36
+
37
+ ```text
38
+ id: string
39
+ title: string | null
40
+ url: string
41
+ pipeline: {id: string, name: string}
42
+ releaseCount: number
43
+ firstRelease: {id: string, name: string} | null
44
+ lastRelease: {id: string, name: string} | null
45
+ generationStatus: string | null
46
+ archivedAt: string | null
47
+ content: string | null
48
+ ```
49
+
50
+ ### `linear release-note delete`
51
+
52
+ Delete a release note by UUID or slug
53
+
54
+ ```
55
+ linear release-note delete [options] <id>
56
+ ```
57
+
58
+ **Output (`--json`)**: a receipt object
59
+
60
+ ```text
61
+ id: string
62
+ deleted: boolean
63
+ ```
64
+
65
+ ### `linear release-note list`
66
+
67
+ List release notes with optional pipeline/release filters
68
+
69
+ Aliases: `ls`
70
+
71
+ ```
72
+ linear release-note list [options]
73
+ ```
74
+
75
+ | Option | Description |
76
+ | ----------------------- | -------------------------------------- |
77
+ | `--pipeline <id\|slug>` | filter by pipeline UUID or slug |
78
+ | `--release <id>` | filter by covered release UUID or slug |
79
+ | `--include-archived` | include archived notes |
80
+
81
+ **Output (`--json`)**: a bare array of objects
82
+
83
+ ```text
84
+ id: string
85
+ title: string | null
86
+ url: string
87
+ pipeline: {id: string, name: string}
88
+ releaseCount: number
89
+ firstRelease: {id: string, name: string} | null
90
+ lastRelease: {id: string, name: string} | null
91
+ generationStatus: string | null
92
+ archivedAt: string | null
93
+ ```
94
+
95
+ ### `linear release-note update`
96
+
97
+ Update a note's title, Markdown, or covered releases
98
+
99
+ ```
100
+ linear release-note update [options] <id>
101
+ ```
102
+
103
+ | Option | Description |
104
+ | --------------------- | ---------------------------------------------- |
105
+ | `--title <title>` | release note title |
106
+ | `--body <text>` | release note body (Markdown) |
107
+ | `--body-file <path>` | read Markdown from file ('-' for stdin) |
108
+ | `--release <id>` | covered release UUID or slug (repeatable) |
109
+ | `--from-release <id>` | oldest release in an inclusive createdAt range |
110
+ | `--to-release <id>` | newest release in the inclusive range |
111
+
112
+ **Output (`--json`)**: a receipt object
113
+
114
+ ```text
115
+ id: string
116
+ title: string | null
117
+ url: string
118
+ pipeline: {id: string, name: string}
119
+ releaseCount: number
120
+ firstRelease: {id: string, name: string} | null
121
+ lastRelease: {id: string, name: string} | null
122
+ generationStatus: string | null
123
+ archivedAt: string | null
124
+ content: string | null
125
+ ```
126
+
127
+ ### `linear release-note view`
128
+
129
+ Show a release note and its Markdown body by UUID or slug
130
+
131
+ ```
132
+ linear release-note view [options] <id>
133
+ ```
134
+
135
+ **Output (`--json`)**: a bare object
136
+
137
+ ```text
138
+ id: string
139
+ title: string | null
140
+ url: string
141
+ pipeline: {id: string, name: string}
142
+ releaseCount: number
143
+ firstRelease: {id: string, name: string} | null
144
+ lastRelease: {id: string, name: string} | null
145
+ generationStatus: string | null
146
+ archivedAt: string | null
147
+ content: string | null
148
+ ```
@@ -0,0 +1,137 @@
1
+ # linear release-pipeline
2
+
3
+ > Manage release pipelines (Business/Enterprise)
4
+
5
+ _Generated from `linear commands --json`. `linear release-pipeline --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>`, `--access-token <token>`, `-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 release-pipeline`
10
+
11
+ Manage release pipelines (Business/Enterprise)
12
+
13
+ ```
14
+ linear release-pipeline [options]
15
+ ```
16
+
17
+ ### `linear release-pipeline create`
18
+
19
+ Create a pipeline with default stages
20
+
21
+ ```
22
+ linear release-pipeline create [options]
23
+ ```
24
+
25
+ | Option | Description |
26
+ | -------------------------------- | -------------------------------------------------------------------------- |
27
+ | `--name <name>` | pipeline name |
28
+ | `--type <type>` | pipeline type |
29
+ | `--production <boolean>` | whether pipeline targets production (true\|false) |
30
+ | `--auto-release-notes <boolean>` | automatically generate notes on completion (true\|false) |
31
+ | `--rollover-issues <boolean>` | move open issues to the next scheduled release on completion (true\|false) |
32
+ | `--include-path <glob>` | replace path patterns with these globs (repeatable) |
33
+ | `--clear-paths` | clear all path filters |
34
+ | `--team-id <uuid>` | replace associated teams with these UUIDs (repeatable) |
35
+ | `--clear-teams` | clear team associations |
36
+
37
+ **Output (`--json`)**: a receipt object
38
+
39
+ ```text
40
+ id: string
41
+ name: string
42
+ slugId: string
43
+ type: string
44
+ url: string
45
+ isProduction: boolean
46
+ autoGenerateReleaseNotesOnCompletion: boolean
47
+ rolloverIssuesOnCompletion: boolean
48
+ includePathPatterns: string[]
49
+ archivedAt: string | null
50
+ ```
51
+
52
+ ### `linear release-pipeline list`
53
+
54
+ List workspace release pipelines
55
+
56
+ Aliases: `ls`
57
+
58
+ ```
59
+ linear release-pipeline list [options]
60
+ ```
61
+
62
+ | Option | Description |
63
+ | -------------------- | -------------------------- |
64
+ | `--include-archived` | include archived pipelines |
65
+
66
+ **Output (`--json`)**: a bare array of objects
67
+
68
+ ```text
69
+ id: string
70
+ name: string
71
+ slugId: string
72
+ type: string
73
+ url: string
74
+ isProduction: boolean
75
+ autoGenerateReleaseNotesOnCompletion: boolean
76
+ rolloverIssuesOnCompletion: boolean
77
+ includePathPatterns: string[]
78
+ archivedAt: string | null
79
+ ```
80
+
81
+ ### `linear release-pipeline update`
82
+
83
+ Update pipeline settings by UUID or slug
84
+
85
+ ```
86
+ linear release-pipeline update [options] <id>
87
+ ```
88
+
89
+ | Option | Description |
90
+ | -------------------------------- | -------------------------------------------------------------------------- |
91
+ | `--name <name>` | pipeline name |
92
+ | `--type <type>` | pipeline type |
93
+ | `--production <boolean>` | whether pipeline targets production (true\|false) |
94
+ | `--auto-release-notes <boolean>` | automatically generate notes on completion (true\|false) |
95
+ | `--rollover-issues <boolean>` | move open issues to the next scheduled release on completion (true\|false) |
96
+ | `--include-path <glob>` | replace path patterns with these globs (repeatable) |
97
+ | `--clear-paths` | clear all path filters |
98
+ | `--team-id <uuid>` | replace associated teams with these UUIDs (repeatable) |
99
+ | `--clear-teams` | clear team associations |
100
+
101
+ **Output (`--json`)**: a receipt object
102
+
103
+ ```text
104
+ id: string
105
+ name: string
106
+ slugId: string
107
+ type: string
108
+ url: string
109
+ isProduction: boolean
110
+ autoGenerateReleaseNotesOnCompletion: boolean
111
+ rolloverIssuesOnCompletion: boolean
112
+ includePathPatterns: string[]
113
+ archivedAt: string | null
114
+ ```
115
+
116
+ ### `linear release-pipeline view`
117
+
118
+ Show pipeline settings by UUID or slug
119
+
120
+ ```
121
+ linear release-pipeline view [options] <id>
122
+ ```
123
+
124
+ **Output (`--json`)**: a bare object
125
+
126
+ ```text
127
+ id: string
128
+ name: string
129
+ slugId: string
130
+ type: string
131
+ url: string
132
+ isProduction: boolean
133
+ autoGenerateReleaseNotesOnCompletion: boolean
134
+ rolloverIssuesOnCompletion: boolean
135
+ includePathPatterns: string[]
136
+ archivedAt: string | null
137
+ ```
@@ -0,0 +1,121 @@
1
+ # linear release-stage
2
+
3
+ > Manage release stages and freeze scheduled release scope
4
+
5
+ _Generated from `linear commands --json`. `linear release-stage --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>`, `--access-token <token>`, `-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 release-stage`
10
+
11
+ Manage release stages and freeze scheduled release scope
12
+
13
+ ```
14
+ linear release-stage [options]
15
+ ```
16
+
17
+ ### `linear release-stage create`
18
+
19
+ Create a stage in a release pipeline
20
+
21
+ ```
22
+ linear release-stage create [options]
23
+ ```
24
+
25
+ | Option | Description |
26
+ | ----------------------- | ------------------------------------------------------------ |
27
+ | `--name <name>` | stage name |
28
+ | `--color <hex>` | six-digit HEX color |
29
+ | `--position <number>` | stage ordering position |
30
+ | `--frozen <boolean>` | exclude this started stage from automated sync (true\|false) |
31
+ | `--pipeline <id\|slug>` | pipeline UUID or slug |
32
+ | `--type <type>` | lifecycle stage type |
33
+
34
+ **Output (`--json`)**: a receipt object
35
+
36
+ ```text
37
+ id: string
38
+ name: string
39
+ type: string
40
+ color: string
41
+ position: number
42
+ frozen: boolean
43
+ pipeline: {id: string, name: string}
44
+ archivedAt: string | null
45
+ ```
46
+
47
+ ### `linear release-stage list`
48
+
49
+ List stages for a pipeline UUID or slug
50
+
51
+ Aliases: `ls`
52
+
53
+ ```
54
+ linear release-stage list [options] <pipeline>
55
+ ```
56
+
57
+ | Option | Description |
58
+ | -------------------- | ----------------------- |
59
+ | `--include-archived` | include archived stages |
60
+
61
+ **Output (`--json`)**: a bare array of objects
62
+
63
+ ```text
64
+ id: string
65
+ name: string
66
+ type: string
67
+ color: string
68
+ position: number
69
+ frozen: boolean
70
+ pipeline: {id: string, name: string}
71
+ archivedAt: string | null
72
+ ```
73
+
74
+ ### `linear release-stage update`
75
+
76
+ Update name, color, order, or frozen state by stage UUID
77
+
78
+ ```
79
+ linear release-stage update [options] <id>
80
+ ```
81
+
82
+ | Option | Description |
83
+ | --------------------- | ------------------------------------------------------------ |
84
+ | `--name <name>` | stage name |
85
+ | `--color <hex>` | six-digit HEX color |
86
+ | `--position <number>` | stage ordering position |
87
+ | `--frozen <boolean>` | exclude this started stage from automated sync (true\|false) |
88
+
89
+ **Output (`--json`)**: a receipt object
90
+
91
+ ```text
92
+ id: string
93
+ name: string
94
+ type: string
95
+ color: string
96
+ position: number
97
+ frozen: boolean
98
+ pipeline: {id: string, name: string}
99
+ archivedAt: string | null
100
+ ```
101
+
102
+ ### `linear release-stage view`
103
+
104
+ Show a release stage by UUID
105
+
106
+ ```
107
+ linear release-stage view [options] <id>
108
+ ```
109
+
110
+ **Output (`--json`)**: a bare object
111
+
112
+ ```text
113
+ id: string
114
+ name: string
115
+ type: string
116
+ color: string
117
+ position: number
118
+ frozen: boolean
119
+ pipeline: {id: string, name: string}
120
+ archivedAt: string | null
121
+ ```