inspect

andurel inspect is read-only project shape discovery. Use it before generating or syncing so agents and humans see the same pad.

Commands

1andurel inspect project --json
2andurel inspect routes --json
3andurel inspect models --json
4andurel inspect migrations --json
5andurel inspect controllers --json
6andurel inspect views --json
7andurel inspect jobs --json

Prefer --json (or --md) for automation. Combine with --jq, --ids-only, or --count when you only need identifiers or a count.

Sample: project

1andurel inspect project --json

 1{
 2  "ok": true,
 3  "data": {
 4    "root": "/home/you/orbit",
 5    "module": "orbit",
 6    "go_version": "1.27.1",
 7    "andurel_version": "v2.0.0-alpha",
 8    "scaffold_config": {
 9      "projectName": "orbit",
10      "inertia": "react",
11      "javascriptPackageManager": "pnpm",
12      "javascriptSSRRuntime": "node"
13    },
14    "database_config": {
15      "engine": "postgresql",
16      "nullType": "pgtype.Null"
17    }
18  },
19  "summary": "Project info loaded"
20}

Sample: routes

1andurel inspect routes --json

 1{
 2  "ok": true,
 3  "data": {
 4    "routes": [
 5      {
 6        "variable": "SessionNew",
 7        "name": "users.new_user_session",
 8        "path": "/users/sign-in",
 9        "constructor": "NewSimpleRoute",
10        "kind": "simple",
11        "is_inertia": true,
12        "source_file": "router/routes/users.go",
13        "line": 9
14      },
15      {
16        "variable": "DocumentationShow",
17        "name": "documentations.show",
18        "path": "/docs/:version/:slug",
19        "constructor": "NewRouteWithParams",
20        "kind": "params",
21        "is_inertia": true,
22        "params": [
23          { "name": "version", "type": "string" },
24          { "name": "slug", "type": "string" }
25        ],
26        "source_file": "router/routes/documentations.go",
27        "line": 30
28      }
29    ]
30  },
31  "summary": "Listed 20 routes (4 skipped)"
32}

Mutating work belongs to generate, sync, and db.