Installation & Setup
Get AIVory Guard running with your AI coding assistant in minutes.
- No API key required to start - free tier works immediately
- One command install via npm or npx
- Automatic connection to AIVory backend
- Works with all major AI agents including Claude Code, Cursor, and more
Prerequisites
Before you begin, ensure you have Node.js 18+ installed on your system.
node --version
Choose Your Plan
AIVory Guard works out of the box without registration. Choose the tier that fits your needs.
Installation
AIVory Guard automatically connects to https://app.aivory.net by default.
For Claude Code
Free tier (no API key needed):
claude mcp add --transport stdio aivory -- npx -y @aivorynet/guard
With full access (all standards, unlimited):
# Get your API key from: https://app.aivory.net/tokens
claude mcp add \
--transport stdio \
--env AIVORY_API_KEY=your-api-key \
aivory \
-- npx -y @aivorynet/guard
For Other AI Agents
# Install globally
npm install -g @aivorynet/guard
# Or use with npx (no installation)
npx @aivorynet/guard test
Get Your API Token
How to generate an API token
Step 1: Visit https://app.aivory.net/tokens
Step 2: Log in or create an account
Step 3: Click “Generate New Token”
Step 4: Copy your API token and keep it secure
Configuration
AIVory Guard uses environment variables for configuration.
| Variable | Description | Default | Required |
|---|---|---|---|
AIVORY_SERVER_URL |
Backend API URL | https://app.aivory.net |
No |
AIVORY_API_KEY |
Your API authentication token | - | No (free tier) |
AIVORY_TIMEOUT |
Request timeout (ms) | 30000 |
No |
Optional: Create a .env file
Create a .env file in your project root:
# .env (optional)
AIVORY_API_KEY=your_api_key_here
Without a .env file, AIVory Guard uses free tier with default settings.
Test Your Installation
Verify that AIVory Guard is working correctly.
npx @aivorynet/guard test
Expected output
✓ Configuration loaded
✓ Server: https://app.aivory.net
✓ Backend is healthy
✓ Compliance scan completed (OWASP Top 10)
All tests passed!
Troubleshooting
Connection Issues
If you can’t connect to the backend:
# Test backend availability
curl https://app.aivory.net/health
Should return: {"status":"healthy"}
Rate Limit Errors
Free tier users may see rate limit errors after:
- 15 files in a single scan
- 3 scans in a day
Solution: Register for full access at app.aivory.net/register/plans
Node.js Version Issues
AIVory Guard requires Node.js 18 or higher. Update if needed:
# Check version
node --version
# Update via nvm (if installed)
nvm install 18
nvm use 18
Next Steps
Configure AIVory Guard with your preferred AI coding assistant.