diff --git a/skills/linear-cli/SKILL.md b/skills/linear-cli/SKILL.md index 2812806f..cd4c181d 100644 --- a/skills/linear-cli/SKILL.md +++ b/skills/linear-cli/SKILL.md @@ -16,7 +16,13 @@ The `linear` command must be available on PATH. To check: linear --version ``` -If not installed, follow the instructions at:\ +If not installed globally, you can run it without installing via npx: + +```bash +npx @schpet/linear-cli --version +``` + +All subsequent commands can be prefixed with `npx @schpet/linear-cli` in place of `linear`. Otherwise, follow the install instructions at:\ https://github.com/schpet/linear-cli?tab=readme-ov-file#install ## Best Practices for Markdown Content @@ -108,6 +114,11 @@ linear issue create --help Each command has detailed help output describing all available flags and options. +Some commands have required flags that aren't obvious. Notable examples: + +- `issue list` requires a sort order — provide it via `--sort` (valid values: `manual`, `priority`), the `issue_sort` config option, or the `LINEAR_ISSUE_SORT` env var. Also requires `--team ` unless the team can be inferred from the directory — if unknown, run `linear team list` first. +- `--no-pager` is only supported on `issue list` — passing it to other commands like `project list` will error. + ## Using the Linear GraphQL API Directly **Prefer the CLI for all supported operations.** The `api` command should only be used as a fallback for queries not covered by the CLI. diff --git a/skills/linear-cli/SKILL.template.md b/skills/linear-cli/SKILL.template.md index 0d2294b0..8d733671 100644 --- a/skills/linear-cli/SKILL.template.md +++ b/skills/linear-cli/SKILL.template.md @@ -16,7 +16,13 @@ The `linear` command must be available on PATH. To check: linear --version ``` -If not installed, follow the instructions at:\ +If not installed globally, you can run it without installing via npx: + +```bash +npx @schpet/linear-cli --version +``` + +All subsequent commands can be prefixed with `npx @schpet/linear-cli` in place of `linear`. Otherwise, follow the install instructions at:\ https://github.com/schpet/linear-cli?tab=readme-ov-file#install ## Best Practices for Markdown Content @@ -80,6 +86,11 @@ linear issue create --help Each command has detailed help output describing all available flags and options. +Some commands have required flags that aren't obvious. Notable examples: + +- `issue list` requires a sort order — provide it via `--sort` (valid values: `manual`, `priority`), the `issue_sort` config option, or the `LINEAR_ISSUE_SORT` env var. Also requires `--team ` unless the team can be inferred from the directory — if unknown, run `linear team list` first. +- `--no-pager` is only supported on `issue list` — passing it to other commands like `project list` will error. + ## Using the Linear GraphQL API Directly **Prefer the CLI for all supported operations.** The `api` command should only be used as a fallback for queries not covered by the CLI.