Help

← Back to Help

⚙️ CodeMap CLI Scanner — Usage & Parameters

This CLI tool allows you to scan your project folder and generate a structured code_map.json for AI use.

📥 Basic Usage

php scan_cli.php [OPTIONS]

🔹 Required Parameter

  • --project=PATH — Relative or absolute path to your project folder

🔸 Optional Parameters

  • --exclude_folders=LIST — Comma-separated folder names to skip (e.g. vendor,node_modules)
  • --exclude_files=LIST — Comma-separated file patterns to ignore (e.g. *.min.js,*.min.css)
  • --analyze_php — Enable PHP file analysis (functions, classes, includes)
  • --analyze_js — Enable JavaScript/TypeScript file analysis (AJAX, globals)
  • --analyze_html — Enable HTML parsing (forms, scripts, templates)
  • --analyze_css — Analyze CSS/SCSS selectors and structure
  • --analyze_sql — Enable database structure parsing via SQL
  • --extract_globals — Extract PHP constants and global JS/window values

📦 SQL Database Parameters (required if using --analyze_sql)

  • --db_host=HOST — MySQL/MariaDB database host (e.g. localhost)
  • --db_user=USER — Database username
  • --db_password=PASS — Database password
  • --db_name=DBNAME — Database name to connect to

✅ Example

php scan_cli.php --project=../projekts --analyze_php --extract_globals
💡 Tip: Combine multiple analysis options to match your stack. You can run scans manually or schedule them with Task Scheduler or cron.

➡️ How to update your Code Map regularly using the CodeMap CLI Scanner →


If you have any questions, feature requests, need help, or want to give feedback — feel free to contact us at