@grafema/cli
v0.3.24
Published
CLI for Grafema code analysis toolkit
Maintainers
Readme
@grafema/cli
Grafema command-line interface for building and querying the code graph.
Warning: This package is in beta stage and the API may change between minor versions.
Quick Start
npx @grafema/cli init
npx @grafema/cli analyze
npx @grafema/cli overviewCommands
Project setup
npx @grafema/cli init # Create .grafema/config.yaml
npx @grafema/cli analyze # Build the graph
npx @grafema/cli overview # Summary of nodes/edges found
npx @grafema/cli schema # List node and edge types
npx @grafema/cli types # List available node typesQuerying the graph
npx @grafema/cli query "auth" # Name search (partial match)
npx @grafema/cli query "function login" # Type + name
npx @grafema/cli query "route /api" # Route search
npx @grafema/cli query "token in authenticate" # Scope filtering
npx @grafema/cli query --type http:request "/api" # Exact type
npx @grafema/cli query --raw 'type(X, "FUNCTION")'Data flow tracing
npx @grafema/cli trace "userId" # Trace variable sources/sinks
npx @grafema/cli trace "userId from authenticate" # Scoped trace
npx @grafema/cli trace --to "addNode#0.type" # Sink-based trace
npx @grafema/cli trace --from-route "GET /status" # Route response traceNavigation helpers
npx @grafema/cli ls --type FUNCTION # List nodes by type
npx @grafema/cli get <semantic-id> # Get a single node by ID
npx @grafema/cli explain <node-id> # Explain a node (summary)Checks & diagnostics
npx @grafema/cli check # Run all guarantees
npx @grafema/cli check dataflow # Run a diagnostic category
npx @grafema/cli check --list-categories
npx @grafema/cli doctor # Validate local setupServer management
npx @grafema/cli server start # Start RFDB server
npx @grafema/cli server stop # Stop RFDB server
npx @grafema/cli server status # Check server statusMisc
npx @grafema/cli coverage # Coverage stats
npx @grafema/cli impact # Impact analysis
npx @grafema/cli explore # Interactive explorer (TUI)
npx @grafema/cli analyze --log-file analysis.log # Log to fileNotes
- All commands accept
--project <path>to point at a specific repo. npx @grafema/cliworks without global install and is preferred for docs/examples.- Unknown Datalog predicates in
--rawqueries will show a warning with suggestions.
