backlog-cli

README

Backlog CLI

Backlog CLI: like gh

This project aims to provide a Backlog CLI that replicates the user experience of the official GitHub CLI.

Installation

Download the binary either by using the installation script or by directly downloading it from the Releases.

# if you want to install to /usr/local/bin
$ curl -sSfL https://raw.githubusercontent.com/shufo/backlog-cli/main/install.sh  | sudo sh -s - -b /usr/local/bin

# if you want to install to /usr/bin
$ curl -sSfL https://raw.githubusercontent.com/shufo/backlog-cli/main/install.sh  | sudo sh -s - -b /usr/bin

Authentication

You must first authenticate with the following command (Required to login to your organization)

$ bk auth login

Troubleshoot

If you had an error like below. Please logout then login to your organization.

Usage

Issue operation

• List Issues

$ bk issue list
# filter isseu assigned to me
$ bk issue list --me
# view issue list on web
$ bk issue list --web

• View Issue

$ bk issue view 123
# view issut on web
$ bk issue view 123 -w

• Create a new Issue

$ bk issue create

• Edit Issue

$ bk issue edit 123

• View Relevant issues

$ bk issue status

• Comment to issue

$ bk issue comment 32

Alias

• Create a shortcut for a bk command

$ bk alias set iv 'issue view'

• List aliases

$ bk alias list

• Delete an alias

$ bk alias delete iv

Configuring backlog-cli

To configure project wide settings, put backlog.json in your repository root, backlog-cli will treat it as settings files.

{
  "backlog_domain": "backlog.com",
  "organization": "your_organization", // <your_organization>.backlog.com
  "project": "MYPROJECT" // your project key
}

TODO

• Add command like gh issue comment

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Testing

$ go test -v ./...

Development

$ GO111MODULE=off go get github.com/oxequa/realize
$ realize start
$ ./app <option> <args>

LICENSE

MIT