Skip to main content

Yellow Pages CLI Reference

All Yellow Pages CLI commands are available under the shift-cli yp namespace. Commands accept either a nanoid(8) ID or a human-readable name wherever an identifier is required.

Global Flags​

FlagDescription
--jsonOutput structured JSON (for agent consumption)
--quietSuppress stdout, exit codes only

Services​

List all services​

shift-cli yp services list

JSON output:

shift-cli yp services list --json
[
  {
    "id": "a1b2c3d4",
    "name": "payment-api",
    "description": "Handles payment processing",
    "tags": ["payments", "core"],
    "system": "billing-system",
    "owner": "platform-team",
    "dependencies": [],
    "createdAt": "2026-03-05T12:00:00.000Z",
    "updatedAt": "2026-03-05T12:00:00.000Z"
  }
]

Get a service​

shift-cli yp services get <id-or-name>
# By name
shift-cli yp services get payment-api

# By ID
shift-cli yp services get a1b2c3d4

Register a service​

shift-cli yp services create

Interactive prompts will guide you through providing the service name, description, tags, system, and owner.

Delete a service​

shift-cli yp services delete <id-or-name>

Systems​

List systems​

shift-cli yp systems list

Create a system​

shift-cli yp systems create

Owners​

List owners​

shift-cli yp owners list

Create an owner​

shift-cli yp owners create

Full-text search​

shift-cli yp search <query>

Example:

shift-cli yp search "payment"

JSON output:

shift-cli yp search "payment" --json
[
  {
    "id": "a1b2c3d4",
    "name": "payment-api",
    "description": "Handles payment processing",
    "tags": ["payments", "core"]
  }
]

Dependencies​

Traverse dependency graph​

shift-cli yp deps <id> [--direction up|down]

Examples:

# Downstream dependencies (what does this service depend on?)
shift-cli yp deps a1b2c3d4 --direction down

# Upstream dependents (what depends on this service?)
shift-cli yp deps a1b2c3d4 --direction up

JSON output:

shift-cli yp deps a1b2c3d4 --direction down --json
{
  "serviceId": "a1b2c3d4",
  "direction": "down",
  "dependencies": [
    {
      "id": "x9y8z7w6",
      "name": "database-service",
      "depth": 1
    }
  ]
}