Installation
Get the GitGone CLI onto your machine.
Install the CLI
The GitGone CLI is the primary way to interact with your secrets. It handles encryption locally, ensuring your raw data never leaves your machine.
Prerequisites: You need Node.js (v20 or newer) installed on your computer.
1. Installation or Quick Run
You can either install the CLI globally for frequent use or run it directly using npx without installing anything.
pnpm add -g @project-gitgone/clinpm install -g @project-gitgone/cliyarn global add @project-gitgone/cliIf you don't want to install the CLI globally, you can prefix any command with npx:
npx @project-gitgone/cli <command>2. Connect to your Server
Before logging in, the CLI needs to know where your GitGone server is located. You can set this globally:
gitgone config set serverUrl https://your-gitgone-server.comAlready have a .gitgone file? If your project already contains a .gitgone configuration file (e.g. you just cloned a repo already using GitGone), you can skip this step. The CLI will automatically use the serverUrl defined in that file for all commands within this directory.
If you are a server administrator, running gitgone admin setup will also configure your serverUrl automatically.
3. Login
Once the URL is set, authenticate your account:
gitgone loginThe CLI will ask for your Email and Password directly in your terminal. This will securely fetch and store your encrypted private vault.
4. Project Initialization
To start using GitGone in a specific project, navigate to your project folder and run:
gitgone initThis interactive command will help you:
- Create a new project on the server OR link an existing one.
- Generate and share the necessary encryption keys.
- Create a local
.gitgonefile to store project-specific settings.
Troubleshooting
Ready? Let's explore the Essential Commands.