Skip to content

Quickstart

Scan your first project in 5 minutes.

1. Initialize

cd your-project
jnkn init

This creates .jnkn/config.yaml with sensible defaults.

2. Scan

jnkn scan

Output:

🔍 Scanning /path/to/your-project
📁 Found 47 files (12 Python, 8 Terraform, 27 other)
✅ Parsed 156 nodes, 89 edges
🧵 Stitching cross-domain dependencies...
✅ Created 8 cross-domain links

3. Explore

View Statistics

jnkn stats

📊 Graph Statistics
═══════════════════════════════════
Nodes:     156
Edges:     97
Files:     47

By Type:
  code_file:       42
  env_var:         12
  infra_resource:  8

Calculate Blast Radius

jnkn blast env:DATABASE_URL

{
  "source": "env:DATABASE_URL",
  "total_impacted": 3,
  "impacted": [
    "file://src/db/connection.py",
    "file://src/api/users.py",
    "infra:aws_db_instance.main"
  ]
}

Explain a Match

jnkn explain env:DB_HOST infra:db_host

Source: env:DB_HOST → Tokens: [db, host]
Target: infra:db_host → Tokens: [db, host]

Confidence: 0.85 (HIGH)
  [+0.90] normalized_match: 'dbhost' == 'dbhost'
  [×0.95] penalty: short token 'db'

What Just Happened?

  1. Parse: Jnkn scanned your Python and Terraform files
  2. Extract: Found environment variables and infrastructure resources
  3. Stitch: Linked env:DATABASE_URL to infra:aws_db_instance.main via token matching
  4. Store: Saved the graph to .jnkn/jnkn.db

Common Issues

No env vars found

Jnkn looks for specific patterns. Check Supported Patterns to ensure your code matches.

Too many false positives

Lower the confidence threshold or add suppressions:

jnkn suppress add "env:*_ID" "infra:*" --reason "ID fields are generic"

Next Steps