Skip to content

arc queries list

Lists all registered query endpoints in the connected Arc application.

Terminal window
cratis arc queries list [--url <URL>] [-o <FORMAT>]
OptionDescription
--url <URL>Base URL of the Arc application (default: http://localhost:5000).
-o, --output <FORMAT>Output format: table, plain, json, json-compact.

Each row contains:

ColumnDescription
NameThe simple name of the query method (e.g. AllAccounts).
NamespaceThe dot-separated namespace path of the query.
RouteThe HTTP GET route registered for this query (e.g. /api/accounts/all-accounts).
TypeThe runtime type name of the query (e.g. ClientObservable, IEnumerable).
SummaryThe XML documentation summary of the query type, if available.
Terminal window
# List queries using the default URL
cratis arc queries list
# List queries from a specific URL
cratis arc queries list --url https://myapp.local:5001
# Output as compact JSON
cratis arc queries list -o json-compact

The introspection endpoint GET /.cratis/queries must be registered in the Arc application. This happens automatically when the application calls MapIntrospectionEndpoints() during startup.