Skip to main content

shift-cli yp

Yellow Pages — the service catalog for the Shift platform.

Usage

shift-cli yp <subcommand> [arguments] [flags]

Sub-commands

Services

CommandDescription
yp services listList all registered services
yp services get <id-or-name>Get details for a specific service
yp services create <name>Register a new service
yp services delete <id-or-name>Remove a service from the catalog

Systems

CommandDescription
yp systems listList all systems
yp systems create <name>Create a new system grouping

Owners

CommandDescription
yp owners listList all service owners
yp owners create <name>Register a new owner

Search and Dependencies

CommandDescription
yp search <query>Search services by name or metadata
yp deps <id-or-name>Show dependency graph for a service

ID-or-Name Resolution

All commands that accept <id-or-name> resolve the argument by checking the nanoid(8) ID first, then searching by name (case-insensitive).

Examples

# List all services as JSON
shift-cli yp services list --json

# Register a new service
shift-cli yp services create my-api

# View a service by name
shift-cli yp services get my-api

# Search for services
shift-cli yp search "auth"

# Show dependencies
shift-cli yp deps my-api

# Delete a service (quiet mode)
shift-cli yp services delete my-api --quiet