Gleef CLI requires Node.js 18.0.0 or higher to run properly.
Installation
We recommend usingnpx
to run Gleef CLI without global installation. This ensures you always use the latest version and avoids permission issues.
1
Recommended: Use npx
Run Gleef CLI directly with npx (no installation required):For easier access, create an alias in your shell profile:
2
Alternative: Global installation
If you prefer global installation for frequent use:Or using yarn:Then verify the installation:
The Gleef CLI is updated frequently with new features and bug fixes. With global installation, you’ll need to manually update to get the latest version.
3
Get your API key
Before using the CLI, you’ll need a Gleef API key:
- Visit https://app.gleef.eu/settings/api-keys
- Generate a new API key for CLI access
- Copy the key for the next step
4
Authenticate with Gleef
Log in to Gleef using your API key:You’ll be prompted to enter your API key. Alternatively, you can provide it directly:
Verification
To verify everything is set up correctly, run:Updating the CLI
If using npx (recommended): No action needed! You automatically get the latest version each time you run the command. If using global installation: Update to the latest version:Troubleshooting Installation
Permission Issues (macOS/Linux)
Recommended solution: Usenpx @gleef/cli
instead of global installation to avoid permission issues entirely.
If you need global installation: You may need to use sudo
:
Windows Installation
On Windows, you may need to run the command prompt as Administrator:- Right-click on Command Prompt or PowerShell
- Select “Run as Administrator”
- Run the installation command
Node.js Version Issues
If you see errors about Node.js version compatibility:- Check your Node.js version:
node --version
- Update Node.js to version 18.0.0 or higher
- Consider using a Node.js version manager like
nvm