Skip to main content

Client-side code analysis tool for API connections

Project description

Rohkun CLI v2

Client-side code analysis tool that finds API connections in your codebase.

Features

  • 🚀 Fast - All analysis happens locally on your machine
  • 🔒 Private - Your code never leaves your computer
  • 🎯 Accurate - Finds endpoints and API calls across multiple languages
  • 📊 Detailed Reports - Saved locally in .rohkun/reports/
  • 💥 Blast Radius - See impact of code changes
  • 📈 Confidence Scoring - Know how reliable each connection is
  • 🔄 Diff Over Time - Compare reports to track changes
  • High Impact Detection - Find critical nodes in your codebase

Installation

pip install rohkun

Quick Start

  1. Get your API key from rohkun.com/dashboard

  2. Configure the CLI:

rohkun config --api-key YOUR_API_KEY
  1. Run analysis on your project:
rohkun run

Or run on a specific directory:

rohkun run /path/to/project

Note: rohkun scan is still available as an alias for backward compatibility.

How It Works

  1. Authorization Check - CLI checks with server if you have credits
  2. Local Analysis - All code analysis happens on your machine
  3. Snapshot Creation - Each scan automatically creates a snapshot (like Git commits)
  4. Automatic Comparison - Starting from your second scan, automatically compares with previous snapshot
  5. Report Generation - Results saved to .rohkun/reports/
  6. Usage Tracking - CLI reports completion to server for billing

Your code is never uploaded to our servers.

Snapshot Workflow

Think of it like Git commits for your architecture:

  • First scan: Creates Snapshot #1 (baseline)
  • Second scan: Creates Snapshot #2, automatically compares with #1
  • Third scan: Creates Snapshot #3, automatically compares with #2
  • And so on...

Each scan shows you exactly what changed—new endpoints, removed API calls, broken connections, and more.

Commands Reference

Quick Reference Table

Command Description
rohkun run [path] Scan codebase and generate report
rohkun run [path] --visualize Scan + open 3D visualization
rohkun config --api-key KEY Set API key
rohkun --version Show version
rohkun --help Show all commands

rohkun run - Analyze Codebase

rohkun run [path] [options]

Scans your codebase for API endpoints, connections, and dependencies.

Arguments:

  • path - Directory to scan (default: current directory)

Options:

  • --visualize - Generate and open interactive 3D knowledge graph
  • -v, --verbose - Show detailed output (blast radius, confidence scores)

Examples:

# Scan current directory
rohkun run

# Scan specific folder
rohkun run ./my-project

# Scan with visualization
rohkun run ./my-project --visualize

# Verbose output
rohkun run -v

Note: rohkun scan is an alias for backward compatibility.


rohkun config - Configure CLI

rohkun config --api-key YOUR_KEY

Saves API key to .rohkun/config.json in your project.

Environment Variables (alternative):

export ROHKUN_API_KEY=your_key_here
export ROHKUN_API_URL=https://custom-api.com  # For self-hosted

rohkun --version

rohkun --version

Shows current CLI version (e.g., Rohkun CLI v2.2.2).


rohkun --help

rohkun --help

Shows all available commands and options.

Supported Languages

  • Python (Flask, FastAPI, Django)
  • JavaScript/TypeScript (Express, Next.js, React)
  • Go (net/http, Gin, Echo)
  • Java (Spring Boot)
  • And more...

Report Format

Reports are saved as JSON in .rohkun/reports/:

{
  "version": "2.0.0",
  "generated_at": "2024-01-15T10:30:00Z",
  "summary": {
    "total_endpoints": 25,
    "total_api_calls": 18,
    "total_connections": 15,
    "high_confidence_connections": 12,
    "medium_confidence_connections": 2,
    "low_confidence_connections": 1,
    "estimated_accuracy": "High (80%+)",
    "high_impact_nodes": 3
  },
  "endpoints": [...],
  "api_calls": [...],
  "connections": [
    {
      "endpoint": {...},
      "api_call": {...},
      "confidence": "high",
      "confidence_score": 85,
      "confidence_reasons": ["HTTP method matches", "Path matches exactly"]
    }
  ],
  "blast_radius": [
    {
      "target": "GET:/api/users",
      "severity": "high",
      "total_dependents": 15,
      "affected_files": [...],
      "impact_description": "..."
    }
  ],
  "high_impact_nodes": [...],
  "accuracy": {...}
}

Configuration

API Key

Set via command:

rohkun config --api-key YOUR_KEY

Or environment variable:

export ROHKUN_API_KEY=your_key_here

Custom API URL

For self-hosted instances:

export ROHKUN_API_URL=https://your-api.com

Troubleshooting

"No API key found"

rohkun config --api-key YOUR_KEY

"Invalid or expired API key"

Get a new key at rohkun.com/dashboard

"Insufficient credits"

Upgrade your plan at rohkun.com/pricing

Privacy

  • Your code is analyzed locally on your machine
  • Only authorization requests are sent to our servers
  • No code content is ever uploaded
  • Reports are saved locally in your project

Support

License

Proprietary - Copyright (c) 2025 Rohkun Labs. All rights reserved.

This is proprietary software. See LICENSE file for full terms and conditions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rohkun-3.0.0.tar.gz (76.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rohkun-3.0.0-py3-none-any.whl (88.3 kB view details)

Uploaded Python 3

File details

Details for the file rohkun-3.0.0.tar.gz.

File metadata

  • Download URL: rohkun-3.0.0.tar.gz
  • Upload date:
  • Size: 76.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for rohkun-3.0.0.tar.gz
Algorithm Hash digest
SHA256 fc79031c0049c834a6d7b4d7c5cfd8badab76093cf7c8eaf23b8043992f425a9
MD5 cfd35c5b65af1181d6ba6641bd9ea9c2
BLAKE2b-256 03fc9fc60900a9a71cb29bb16436a225b43228457584ebf662fe2b7642f46149

See more details on using hashes here.

File details

Details for the file rohkun-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: rohkun-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 88.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for rohkun-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71ca13a982d0a89756d3d2f0fbbb6218116da95b841343e58fff240a2cc35c46
MD5 9840a19647a6999cc021dfce810863e4
BLAKE2b-256 3d350d1a5ae2c3fd6db32cacff40aaea3ff0986831bcd8e13dcd7dbdb4b427e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page