Gitsecure CLI

Gitsecure CLI is a cutting-edge SecretOps infrastructure designed for developers and teams.

Useful links

• Github repository
• [Project documentation]

Requirements

• Go version 1.19 or higher
• Cobra version 1.6.1

Running the application

To run the CLI, follow the steps below:

 # Build the CLI Locally
 $ go build
 # Install the CLI after the build 
 $ go install 

Contributing

To contribute to Gitsecure CLI, please follow these steps:

1. Pick an issue from the GitHub repository.
2. Clone the repository using the following command:

 $ git clone https://github.com/GitsecureHQ/gitsecure

3. When creating a new branch, use the following naming convention: GSC-<issue-no>-<short-description>, for example, GSC-1-project-setup. The main branch should be based on develop.
4. When creating a pull request, select develop as the target branch.

Pushing changes to the repository

Use the following commands to push changes to the repository:

# If pushing for the first time
$ git push -u origin <branchname>

# If pushing normally
$ git push

Install the CLI

# Scoop For Windows 

$ scoop bucket add gitsecurehq https://github.com/GitsecureHQ/scoop-gitsecure
$ scoop install gitsecure
$ gitsecure --version

# Brew For Mac And Linux Users

$ brew tap GitsecureHQ/brew
$ brew install gitsecure
$ gitsecure --version

# NPM specific for Windows users

$ npm i -g @gitsecure/cli
$ gitsecure --version