diff --git a/Readme.adoc b/Readme.adoc index 22e907c..407ac77 100644 --- a/Readme.adoc +++ b/Readme.adoc @@ -1,4 +1,5 @@ = Linear Command line interface (Elixir) +Tj Vanderpoel (bougyman) :toc: right :toclevels: 3 :sectanchors: @@ -291,6 +292,8 @@ $ lc issue pr CRY-1234 ==== Update an issue All of the update options can work on multiple issues at a time. +See link:documents/body-file.adoc[`--body-file`: context-specific file input] +for how file-backed text maps to each command. ===== Add a comment to one or more issues diff --git a/documents/ash-domain-erd.adoc b/documents/ash-domain-erd.adoc index db63a56..697c144 100644 --- a/documents/ash-domain-erd.adoc +++ b/documents/ash-domain-erd.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 18, 2026 :my-title: Ash domain ERD: LinearCli.Linear :icons: font diff --git a/documents/body-file.adoc b/documents/body-file.adoc new file mode 100644 index 0000000..003eae6 --- /dev/null +++ b/documents/body-file.adoc @@ -0,0 +1,48 @@ += --body-file: context-specific file input +Tj Vanderpoel (bougyman) +:revdate: Sep 4, 2026 +:icons: font +:env-github: +ifdef::env-github[] +:tip-caption: :bulb: +:note-caption: :information_source: +:important-caption: :heavy_exclamation_mark: +:caution-caption: :fire: +:warning-caption: :warning: +endif::[] + +`--body-file PATH` supplies the long, multi-line text input for the command +where it appears. It is deliberately a context-specific argument, rather than +a global synonym for one particular field: `PATH` is read verbatim, and `-` +reads from standard input. + +This avoids placing a multi-line document in one shell argument. It also makes +the command's purpose clear at the call site: the surrounding subcommand says +which body is being supplied. + +== Current contexts + +* `lc issue create --body-file PATH` supplies the new issue's *description*. + It is mutually exclusive with `--description`. +* `lc issue comment ISSUE_ID --body-file PATH` supplies the new *comment + body*. It is mutually exclusive with `--comment`. + +== Planned update context + +`lc issue update ISSUE_ID --body-file PATH` will supply the issue +*description* being updated. It will be mutually exclusive with +`--description`; it must not change the meaning of `--comment`, `--reason`, +or any other update input. + +For example: + +[source,sh] +---- +$ lc issue create --title "Design notes" --body-file design-notes.md +$ lc issue comment EXT-123 --body-file review.md +$ lc issue update EXT-123 --body-file revised-description.md +$ printf '%s\\n' 'A comment from stdin' | lc issue comment EXT-123 --body-file - +---- + +The update example above documents the intended interface; it becomes usable +when the corresponding `issue update` work is implemented. diff --git a/documents/burrito-decision.adoc b/documents/burrito-decision.adoc index be91576..07da482 100644 --- a/documents/burrito-decision.adoc +++ b/documents/burrito-decision.adoc @@ -1,5 +1,5 @@ = Burrito distribution decision -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Sep 04, 2026 :icons: font :env-github: diff --git a/documents/initial-plan.adoc b/documents/initial-plan.adoc index 4fb4037..072ce43 100644 --- a/documents/initial-plan.adoc +++ b/documents/initial-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 07, 2026 :my-title: Initial Plan for porting linear-cli to elixir :icons: font diff --git a/documents/motivation.adoc b/documents/motivation.adoc index fb2365e..c832ce6 100644 --- a/documents/motivation.adoc +++ b/documents/motivation.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 14, 2026 :my-title: Motivation :icons: font diff --git a/documents/phase-10-plan.adoc b/documents/phase-10-plan.adoc index fe44b95..b583419 100644 --- a/documents/phase-10-plan.adoc +++ b/documents/phase-10-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 10, 2026 :my-title: Phase 10 plan: favorite teams/projects, and filtering list views by them :icons: font diff --git a/documents/phase-11-plan.adoc b/documents/phase-11-plan.adoc index 0c65c8c..5d4956f 100644 --- a/documents/phase-11-plan.adoc +++ b/documents/phase-11-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 10, 2026 :my-title: Phase 11 plan: bare issue numbers, resolved via profile then favorited teams :icons: font diff --git a/documents/phase-12-plan.adoc b/documents/phase-12-plan.adoc index 73e5860..1859574 100644 --- a/documents/phase-12-plan.adoc +++ b/documents/phase-12-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 23, 2026 :my-title: Phase 12 plan: bulk issue move between projects (`lc issue move`) :icons: font diff --git a/documents/phase-13-plan.adoc b/documents/phase-13-plan.adoc index c773d7b..06649e9 100644 --- a/documents/phase-13-plan.adoc +++ b/documents/phase-13-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 31, 2026 :my-title: Phase 13 plan: safe multi-line comments for Stokowski (`lc issue comment`) :icons: font diff --git a/documents/phase-14-plan.adoc b/documents/phase-14-plan.adoc index 0542b99..356aaf6 100644 --- a/documents/phase-14-plan.adoc +++ b/documents/phase-14-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Sep 04, 2026 :my-title: Phase 14 plan: end-to-end Conventional Commits and pull request title enforcement :icons: font diff --git a/documents/phase-15-plan.adoc b/documents/phase-15-plan.adoc index e033490..a506aea 100644 --- a/documents/phase-15-plan.adoc +++ b/documents/phase-15-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Sep 04, 2026 :my-title: Phase 15 plan: separate developer and CI quality gates :icons: font diff --git a/documents/phase-16-plan.adoc b/documents/phase-16-plan.adoc index e8bcac5..1e91325 100644 --- a/documents/phase-16-plan.adoc +++ b/documents/phase-16-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Sep 04, 2026 :my-title: Phase 16 plan: issue relationship support :icons: font diff --git a/documents/phase-6-plan.adoc b/documents/phase-6-plan.adoc index b20042a..77ca150 100644 --- a/documents/phase-6-plan.adoc +++ b/documents/phase-6-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 07, 2026 :my-title: Phase 6 plan: write/mutation commands :icons: font diff --git a/documents/phase-7-plan.adoc b/documents/phase-7-plan.adoc index 1b387eb..d9be711 100644 --- a/documents/phase-7-plan.adoc +++ b/documents/phase-7-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 07, 2026 :my-title: Phase 7 plan: scheduled workflows (Oban + monthly project rollover) :icons: font diff --git a/documents/phase-8-plan.adoc b/documents/phase-8-plan.adoc index 4cc361b..400e123 100644 --- a/documents/phase-8-plan.adoc +++ b/documents/phase-8-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 07, 2026 :my-title: Phase 8 plan: packaging, releasing, and CI :icons: font diff --git a/documents/phase-9-plan.adoc b/documents/phase-9-plan.adoc index 0b34432..addf6d5 100644 --- a/documents/phase-9-plan.adoc +++ b/documents/phase-9-plan.adoc @@ -1,5 +1,5 @@ = {my-title} -Tj Vanderpoel (bougyman) +Tj Vanderpoel (bougyman) :revdate: Aug 10, 2026 :my-title: Phase 9 plan: profiles - default team/project (toward 1.0) :icons: font diff --git a/vendor/stokowski b/vendor/stokowski index 73bbbcf..2a43887 160000 --- a/vendor/stokowski +++ b/vendor/stokowski @@ -1 +1 @@ -Subproject commit 73bbbcf6e4284e768263df23c673948fe85eb81c +Subproject commit 2a43887511e8b3d16559e84c6e8626cef43646de