Skip to content

Commit

Permalink
Adds real readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bougyman committed Jan 29, 2024
1 parent a87231a commit e8d4158
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 31 deletions.
31 changes: 0 additions & 31 deletions README.md

This file was deleted.

44 changes: 44 additions & 0 deletions Readme.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
= Linear Command line interface
:toc: right
:toclevels: 2
:sectanchors:
:icons: font
:experimental:

A command line interface to https://linear.app.

== Installation

=== From Source

[source,sh]
----
$ git clone https://github.com/rubyists/linear-cli.git
$ cd linear-cli
$ bundle install
$ bundle exec rake install
----

== Usage

=== Configuration

You must set the LINEAR_API_KEY environment variable to your Linear API key. You can find your API key at https://linear.app/settings/api.

=== Commands

==== Who Am I?

[source,sh]
----
$ lc whoami
$ lc whoami --teams
----

==== List Issues

[source,sh]
----
$ lcls
$ lcls --full
----

0 comments on commit e8d4158

Please sign in to comment.