Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.krypthq.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

​
Install with npm

npm install -g @kryptorg/cli
Verify the install: 
krypt --version
Expected output: 
2.1.1

​
Permission errors

If you see EACCES or “permission denied” errors during install:
  • macOS / Linux — prefix the command with sudo
  • Windows — open your terminal as Administrator
sudo npm install -g @kryptorg/cli

​
Alternative package managers

yarn global add @kryptorg/cli

​
Updating the CLI

Install the latest version over the existing one: 
npm install -g @kryptorg/cli@latest
Or pin a specific version: 
npm install -g @kryptorg/cli@2.1.1

​
Uninstalling

npm uninstall -g @kryptorg/cli
This removes the binary but does not delete your stored credentials. To fully remove Krypt from your system:
rm -rf ~/.krypt

​
CLI configuration

After running krypt login, the CLI stores config at ~/.krypt/config.json with 0600 permissions (owner-only read/write): 
{
  "apiKey": "krypt_live_...",
  "apiUrl": "https://api.krypthq.com"
}
Override the API URL with the KRYPT_API_URL environment variable — useful for self-hosted deployments or testing: 
export KRYPT_API_URL=https://api.example.com
krypt whoami
In each project directory, krypt init creates a .krypt file linking that folder to a Krypt project: 
{
  "project": "my-app",
  "environment": "development"
}

​
Troubleshooting

“krypt: command not found” Your npm global bin directory is not in your PATH. Run npm config get prefix and add <prefix>/bin to your shell profile. See the npm docs on resolving global install issues. “Cannot find module” errors Reinstall with --force to rebuild native dependencies: 
npm install -g @kryptorg/cli --force
Network errors during install If you’re behind a corporate proxy, configure npm to use it: 
npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080
See the npm proxy configuration docs.

​
Next steps

  • Quickstart — push your first secret in 5 minutes
  • CLI commands — full reference for every command and flag