Skip to content

a simple CLI for working with git providers; like github `gh` but for any git provider

License

Notifications You must be signed in to change notification settings

jenkins-x-plugins/jx-scm

Repository files navigation

jx-scm

Documentation Go Report Card Releases LICENSE Slack Status

jx-scm is a small command line tool working with git providers using go-scm

Getting Started

Download the jx-scm binary for your operating system and add it to your $PATH.

Authentication

To use commands below you will need to authenticate with a Git provider. This can be done by passing global flags or setting environment variables:

jx-scm foo \
  --server https://github.com \
  --token abc123 \
  --kind github
export GIT_SERVER=https://github.com
export GIT_TOKEN=abc123
export GIT_KIND=github

jx-scm foo

Commands

See the jx-scm command reference

Developing

If you wish to work on a local clone of go-scm then:

git clone https://github.com/jenkins-x/go-scm

Then in the local go.mod file add the following at the end:

replace github.com/jenkins-x/go-scm  => PathToTheAboveGitClone

You can now build this repository using your local modifications and try the locally built binary in build/jx-scm or run the unit tests via make test