Help & Documentation

Getting Started

1. Create an Account

Sign up for a Rohkun account to get started. You'll need an account to generate API keys and access the dashboard.

2. Get Your API Key

After signing up, navigate to your dashboard and generate an API key. This key authenticates your CLI requests.

Important: Keep your API key secure. Never commit it to version control or share it publicly.

3. Install the CLI

Install Rohkun using pip:

pip install rohkun

4. Configure Your API Key

Set your API key:

rohkun config --api-key YOUR_API_KEY

5. Run Your First Scan

Navigate to your project directory and run:

rohkun run

This will scan your codebase and generate a report mapping your architecture.

How to Use Rohkun

Think of Rohkun like Git commits for your architecture. Each time you run rohkun run, it automatically creates a snapshot of your current architecture state. Here's a recommended workflow:

After Completing a Feature

When you finish implementing a feature, run a scan to save the current state:

rohkun run

This automatically creates a snapshot with a sequence number (e.g., Snapshot #1, #2, #3).

Before Making Big Changes

Before refactoring or making significant architectural changes, run a scan to capture the current state:

rohkun run

After Making Changes

After completing your changes, run another scan to capture the new state:

rohkun run

Automatic Comparison

Starting from your second scan, rohkun run automatically compares your current architecture with the previous snapshot and shows you exactly what changed—new endpoints, removed API calls, broken connections, and more. No flags needed!

This workflow lets you save states automatically and compare them, similar to how you use Git to track code changes over time. Each rohkun run creates a new snapshot and automatically shows you the differences from the previous one.

Understanding Reports

What Rohkun Analyzes

Rohkun maps your codebase by identifying:

  • Endpoints: API routes and entry points
  • API Calls: External API requests and integrations
  • Dependencies: Module imports and relationships
  • File Locations: Exact file paths and line numbers

AST Parsing

Rohkun uses AST (Abstract Syntax Tree) parsing to analyze your code. This allows us to understand code structure statically without executing it.

Limitations: Some patterns cannot be determined through static analysis alone. When we cannot definitively identify something, we:

  • Mark it as uncertain in the report
  • Provide the best possible location for manual review
  • Allow you or your AI to investigate further

Common Commands

rohkun run # Run a scan (creates snapshot & compares automatically) rohkun run --verbose # Show detailed output rohkun config --api-key KEY # Set API key rohkun --version # Show version rohkun --help # Show help

Supported Languages

Rohkun supports analysis for:

  • Python
  • JavaScript
  • TypeScript
  • Java
  • Go
  • Ruby
  • PHP
  • Rust

Framework awareness is built-in for accurate detection across popular frameworks.

Credits and Billing

Monthly Plans

Credits renew each month on your billing date. Unused credits do not roll over.

Yearly Plans

Yearly plans provide credits as a lump sum for the entire year. These credits are not monthly renewed. You receive the full amount upfront and can use them throughout the year.

Troubleshooting

API Key Issues

If you're getting authentication errors:

  1. Verify your API key is correct in your configuration
  2. Check that your API key hasn't been revoked
  3. Generate a new API key from your dashboard if needed

Scan Errors

If scans are failing:

  1. Ensure you're in the correct project directory
  2. Check that you have sufficient credits
  3. Verify your codebase contains supported file types

Need More Help?

For additional support, check our Terms of Service or contact us through your dashboard.