This project aims to provide a Backlog CLI that replicates the user experience of the official GitHub CLI.
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
You must first authenticate with the following command (Required to login to your organization)
$ backlog auth login
If you had an error like below. Please logout then login to your organization.
- List Issues
$ backlog issue list
# filter isseu assigned to me
$ backlog issue list --me
# view issue list on web
$ backlog issue list --web
- View Issue
$ backlog issue view 123
# view issut on web
$ backlog issue view 123 -w
- Create a new Issue
$ backlog issue create
- Edit Issue
$ backlog issue edit 123
- View Relevant issues
$ backlog issue status
- Comment to issue
$ backlog issue comment 32
- Create a shortcut for a
backlog
command
$ backlog alias set iv 'issue view'
- List aliases
$ backlog alias list
- Delete an alias
$ backlog alias delete iv
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
}
- Add command like
gh issue comment
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
$ go test -v ./...
$ GO111MODULE=off go get github.com/oxequa/realize
$ realize start
$ ./app <option> <args>
MIT