Getting Started with Code Observatory

Installation

Install Code Observatory CLI using npm, yarn, or download the binary directly.

bash 
# Using npm
npm install -g @codeobs/cli

# Using yarn
yarn global add @codeobs/cli

# Verify installation
codeobs --version

Quick Start

Get up and running in under 5 minutes:

1

Initialize Your Project

codeobs init
2

Run Your First Scan

codeobs scan --all
3

View Results

codeobs dashboard

Configuration

Customize Code Observatory for your project with a codeobs.config.json file:

json 
{
  "scan": {
    "dependencies": true,
    "vulnerabilities": true,
    "licenses": true
  },
  "thresholds": {
    "riskScore": "B",
    "vulnerabilities": {
      "critical": 0,
      "high": 2
    }
  },
  "integrations": {
    "github": {
      "enabled": true,
      "autoFix": true
    }
  }
}

Need Help?

Check out our comprehensive guides or join our community forum for support.