linearcreate

Linear CLI Tool (lc)

lc (Linear Create and Open) is a command-line interface tool that simplifies the process of creating Linear issues and generating corresponding branch names. It integrates with the Linear API to create issues and provides options for opening the issue in the browser or copying a generated branch name to the clipboard.

Features

• Create Linear issues from the command line
• Generate branch names based on the created issue
• Open the created issue in the default web browser
• Copy the generated branch name to the clipboard
• Specify team stub for issue creation
• Configuration file support for API key and default settings

Installation and Setup

• Install the package globally:

  npm install -g linear-cli-tool
  

• Run the setup command:

  lc setup
  

  This will prompt you for:

  • Your Linear API key
  • Your Linear user ID
  • Default team stub

• The setup process will create a .lc-config file in your home directory with these settings.

Obtaining Your Linear User ID

To get your Linear user ID:

• Open Linear in your web browser
• Right-click anywhere on the page
• Select Inspect to open the developer tools
• In the developer tools, go to the Console tab
• Type Developer: Copy model UUID... and press Enter
• Select User from the dropdown menu
• Your user ID will be copied to your clipboard

Usage

lc [options]

Options

• -t, --teamstub <stub>: Specify the team stub (e.g., bknd, frtd). Defaults to the value in the config file.
• -o, --open: Open the created issue in Linear using the default web browser.
• -d, --description <text>: Add a description to the Linear issue.
• --help: Show help information.

Examples

• Create an issue and copy the branch name to clipboard:

  lc "Implement user authentication"
  

• Create an issue for a specific team and open it in the browser:

  lc "Fix pagination bug" -t bknd -o
  

• Create an issue with a description:

  lc "Add new API endpoint" -d "This endpoint will handle user profile updates"
  

• Show help information:

  lc --help
  

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.