quirgo
v0.0.4
Published
A CLI tool to automate repositories secrets and variables setting via the Gihub API
Downloads
5
Readme
Quirgo CLI
Quirgo is a command line interface tool built to easily configure repository secrets and variables. It assists in the process of automating application deployment with features such as batch sets of secrets/variables by providing an easy way to perform CRUD (Create | Read | Update | Delete) operations on them.
Installation
Install Quirgo globally by running:
yarn add -g quirgo
or
pnpm add -g quirgo
or
npm install -g quirgo
Usage
To start using Quirgo, run:
quirgo
Commands
- vars
- list
- create
- update
- remove
- secrets
- list
- set
- remove
Example
The following example shows how to set a list of secrets loaded from a .env file in one command:
quirgo secrets set --token=xxxxxxxxx --repo=repository --owner=owner --env=/path/to/env/file
File parsing
It is possible to load variables/secrets from .env and .json files, as long as the key-value format is respected. The json file look like this:
{ "KEY": "VALUE" }
Notes
To run Quirgo requires at least the following permissions
- Read/write access to repository secrets and variables
- Read access to user information (specifically the user's username).
For more information about the profile information Quirgo has access to, see the official GitHub API documentation.
Quirgo uses the public Github API under the hood, so you will need a Personal Access Token (--token) to perform any action. If you'd like to define specific permissions for a P.A.T., read this.
License
Quirgo is MIT licensed.