Skip to main content

Quickstart Guide

Get started with Keymate quickly using this guide.

First Steps​

  1. Sign Up Visit Keymate.ai and create an account.

  2. Create a Project

    # Initialize a new project
    keymate init my-project
    cd my-project

  3. Configure Your Environment

    # Set up your API key
    export KEYMATE_API_KEY=your_api_key

Basic Usage​

1. Security Scanning​

# Scan your codebase for vulnerabilities
keymate scan

# Scan a specific directory
keymate scan ./src

# Generate a detailed report
keymate scan --report

2. Threat Detection​

# Monitor your infrastructure
keymate monitor

# Set up alerts
keymate alerts configure

3. Compliance​

# Check compliance status
keymate compliance check

# Generate compliance report
keymate compliance report

Integration Examples​

Python Integration​

from keymate import Client

client = Client(api_key="your_api_key")

# Scan code
results = client.scan_code("./src")

# Monitor infrastructure
client.start_monitoring()

JavaScript Integration​

const { KeymateClient } = require('keymate');

const client = new KeymateClient({
  apiKey: 'your_api_key'
});

// Scan code
client.scanCode('./src')
  .then(results => console.log(results));

// Monitor infrastructure
client.startMonitoring();

Best Practices​

  1. Regular Scanning

    • Set up automated scans in your CI/CD pipeline
    • Schedule regular security assessments

  2. Monitoring

    • Enable real-time monitoring for critical systems
    • Configure appropriate alert thresholds

  3. Compliance

    • Regular compliance checks
    • Keep documentation up to date

Next Steps​