Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,13 +233,15 @@ linear completions # generate shell completions

the CLI supports configuration via environment variables or a `.linear.toml` config file. environment variables take precedence over config file values.

| option | env var | toml key | example | description |
| --------------- | ------------------------ | ----------------- | -------------------------- | ------------------------------------- |
| Team ID | `LINEAR_TEAM_ID` | `team_id` | `"ENG"` | default team for operations |
| Workspace | `LINEAR_WORKSPACE` | `workspace` | `"mycompany"` | workspace slug for web/app URLs |
| Issue sort | `LINEAR_ISSUE_SORT` | `issue_sort` | `"priority"` or `"manual"` | how to sort issue lists |
| VCS | `LINEAR_VCS` | `vcs` | `"git"` or `"jj"` | version control system (default: git) |
| Download images | `LINEAR_DOWNLOAD_IMAGES` | `download_images` | `true` or `false` | download images when viewing issues |
| option | env var | toml key | example | description |
| --------------- | --------------------------------- | -------------------------- | ---------------------------------- | ----------------------------------------------------- |
| Team ID | `LINEAR_TEAM_ID` | `team_id` | `"ENG"` | default team for operations |
| Workspace | `LINEAR_WORKSPACE` | `workspace` | `"mycompany"` | workspace slug for web/app URLs |
| Issue sort | `LINEAR_ISSUE_SORT` | `issue_sort` | `"priority"` or `"manual"` | how to sort issue lists |
| Ask project | `LINEAR_ISSUE_CREATE_ASK_PROJECT` | `issue_create_ask_project` | `true` or `false` | ask for a project during interactive `issue create` |
| Assign self | `LINEAR_ISSUE_CREATE_ASSIGN_SELF` | `issue_create_assign_self` | `"always"`, `"auto"`, or `"never"` | control default self-assignment during issue creation |
| VCS | `LINEAR_VCS` | `vcs` | `"git"` or `"jj"` | version control system (default: git) |
| Download images | `LINEAR_DOWNLOAD_IMAGES` | `download_images` | `true` or `false` | download images when viewing issues |

the config file can be placed at (checked in order, first found is used):

Expand Down
2 changes: 2 additions & 0 deletions docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ you can also set the API key in a project's `.linear.toml`:
api_key = "lin_api_..."
workspace = "acme"
team_id = "ENG"
issue_create_assign_self = "always"
issue_create_ask_project = true
```

this is useful for project-specific credentials but less secure than stored credentials since it may be committed to version control.
Expand Down
Loading
Loading