0.1.1 • Published 5 months ago

@mixpeek/linear-cli v0.1.1

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

npm downloads node

WIP

Linear CLI

A modern, user-friendly CLI client for Linear built with TypeScript. Uses Linear's Typescript SDK. This CLI provides an improved developer experience for interacting with Linear's API.

Screenshot of @mixpeek/linear-cli running the 'issues list' command

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

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

# Initialize the CLI with an API key
linear-cli init

Usage

# 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:
git clone https://github.com/mixpeek/linear-cli.git
cd linear-cli
  1. Install dependencies:
npm install
# or
yarn install
  1. Build the project:
npm run build
# or
yarn build
  1. Link the package for development:
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.