gitbucket-cli

command module
v0.0.0-...-84c8c5a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2024 License: MIT Imports: 1 Imported by: 0

README

GitBucket CLI

GitBucket CLI is a tool for seamless integration with GitBucket from the command line. You can use it to manipulate repositories, issues, organizations, etc.

screenshot of repo create

Table of Contents

Features

You can do the following from the command line.

  • Create, retrieve, and clone repositories
  • Create and retrieve organizations
  • Create and retrieve labels for repositories
  • Create and retrieve issues in repositories

Motivation

I use GitHub in my private life, but I use GitBucket at work. GitBucket does not have a tool such as gh that allows seamless command line integration. For example, if I want to create a repository, I usually need to use a browser. Fortunately, GitBucket has some APIs, so I thought it would be possible to operate from the command line using those APIs.

Installation

go install github.com/guitarinchen/gitbucket-cli@latest

Usage

Setup
  • Generate personal access token on GitBucket (Account settings > Applications)
  • Set environment variables
    # It is recommended that these are set in ~/.bashrc or ~/.zshrc.
    export GITBUCKET_API_TOKEN="<generated_token>"
    export GITBUCKET_API_BASE_URL="https://<your_gitbucket_domain>/api/v3"
    
Execute
Create a repository

gitbucket-cli repo create <repository_name>

Show help

gitbucket-cli --help

Contribution

Thanks for taking the time to contribute. For detailed instructions on how to get started with our project, see CONTRIBUTING.md.

Inspiration

License

MIT License

Documentation

Overview

Copyright © 2024 guitarinchen <guitarinchen@gmail.com>

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL