README.md

lnr

• lnr
  • Working with issues
  • Working with templates
    • Create a series of tickets from a TOML file
    • Create a series of tickets from all TOML files in a directory
  • Installation
    • Crates.io (Linux, Mac, and Windows)
    • AUR (Arch-based Linux)
    • GitHub (Linux, Mac, and Windows)
  • Contributing

A Linear command line client

Working with issues

Add an organization and token. Your token can be generated in Linear Settings

lnr org add

Create a new issue

lnr issue create

View issue (linked to current branch)

lnr issue view

Edit issue (linked to current branch)

lnr issue edit

Working with templates

Create a series of tickets from a TOML file

Input file (uses handlebars-style variables)

# build_batcave.toml
[variables]
name = "Alfred"

[parent]
title = "This is a parent issue"
description = """
We need to create a batcave

Make sure to coordinate with {{name}}

See child tickets
"""

[[children]]
title = "This is a child issue for {{name}} to complete"
description = """
Figure out where to put the batcave

 - Some place dark and dingy
 - Make sure to coordinate with {{name}}
"""

[[children]]
title = "This is a second child issue that will be linked to the parent issue"
description = """
Make sure that we have enough bats

### Acceptance Criteria

- [ ] They can't bite too much
- [ ] At least a dozen
- [ ] Don't overdo it this time
"""

Command

lnr template evaluate --path ~/Documents/build_batcave.toml

Create a series of tickets from all TOML files in a directory

When passed a directory, Linear Templater will recursively walk through the directory and all sub-directories and create tickets from all the TOML files that are not Cargo.toml.

Command

# Create tickets from all TOML files in the current directory
lnr template evaluate --path .

Installation

Crates.io (Linux, Mac, and Windows)

Install Rust

# Linux and MacOS
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Install lnr

cargo install lnr

AUR (Arch-based Linux)

# Use yay or another AUR helper
yay lnr-bin

GitHub (Linux, Mac, and Windows)

Install Rust

Clone the project

git clone git@github.com:alanvardy/lnr.git
cd tod
./test.sh # run the tests
cargo build --release

You can then find the binary in /target/release/

Contributing

Contributions are welcome, be sure to open up an issue first!