https://github.com/mixpeek/linear-cli
A CLI tool for interacting with Linear.app
https://github.com/mixpeek/linear-cli
cli linear tui
Last synced: 9 months ago
JSON representation
A CLI tool for interacting with Linear.app
- Host: GitHub
- URL: https://github.com/mixpeek/linear-cli
- Owner: mixpeek
- License: mit
- Created: 2025-05-08T00:51:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-05-08T18:55:16.000Z (11 months ago)
- Last Synced: 2025-06-06T18:13:16.256Z (10 months ago)
- Topics: cli, linear, tui
- Language: TypeScript
- Homepage:
- Size: 458 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-agent-cli - linear-cli - cli?style=flat-square&label=) | TypeScript | ![community][community] ![agent-friendly][agent-friendly] | CLI tool for interacting with Linear.app. | (Project Management)
README
WIP
# Linear CLI
A modern, user-friendly CLI client for [Linear](https://linear.app/) built with TypeScript. Uses Linear's [Typescript SDK](https://github.com/linear/linear/tree/master/packages/sdk). This CLI provides an improved developer experience for interacting with Linear's API.
## Features
- Modern TypeScript implementation
- Interactive CLI with beautiful UI using Ink
- Linear API support via @linear/sdk
- Type-safe command handling
- Modern development tooling
## Prerequisites
- Node.js >= 18.0.0
- npm or yarn
- Linear API key
## Installation
```bash
npm install -g @mixpeek/linear-cli
# or
yarn global add @mixpeek/linear-cli
```
## Setup
To use, you must set up a 'Personal API Key' in your Linear account, here: https://linear.app/mixpeek/settings/account/security
```bash
# Initialize the CLI with an API key
linear-cli init
```
## Usage
```bash
# List all issues
linear-cli issues list
# Create a new issue interactively
linear-cli issues create -i
# View issue details
linear-cli issues view ISSUE-123
```
## Development Setup
1. Clone the repository:
```bash
git clone https://github.com/mixpeek/linear-cli.git
cd linear-cli
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Build the project:
```bash
npm run build
# or
yarn build
```
4. Link the package for development:
```bash
npm link
# or
yarn link
```
## Available Scripts
- `npm run build` - Build the project
- `npm run dev` - Run in development mode with watch
- `npm run dev:run` - Run in development mode with watch and execute
- `npm run test` - Run tests
- `npm run test:coverage` - Run tests with coverage
- `npm run lint` - Run ESLint
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License.