Skip to content

Commit

Permalink
Add README (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
schpet authored Nov 24, 2024
1 parent 03ba7c9 commit cac9347
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.aider.*
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# linear cli

cli tool for linear.app that uses git branch names and directory names to open
issues and team pages.

## install

### from jsr

```bash
deno install jsr:@schpet/linear
```

### local install

```bash
git clone https://github.com/schpet/linear-cli
cd linear
deno task install
```

## usage

### environment variables

first create an api key:

1. go to https://linear.app/settings/api
2. click "create key"
3. name it something like "cli"
4. copy the key

then export these environment variables:

```bash
export LINEAR_API_KEY="lin_api_..." # paste your api key here
export LINEAR_WORKSPACE="your-company" # your linear.app workspace url slug
```

### team pages

name your project directories with your linear team prefix:

```bash
mkdir eng-project # eng is the team prefix
cd eng-project
linear team # opens eng team page
```

### issues

create branches that include linear issue ids:

```bash
git switch -c eng-123-do-something
linear issue # opens eng-123 in linear
linear issue print # prints issue title and description
```

note that
[linear's github integration](https://linear.app/docs/github#branch-format) will
suggest these branch names.

## commands

```bash
linear --help # show all commands
linear issue --help # show issue commands
linear team --help # show team commands
```

0 comments on commit cac9347

Please sign in to comment.