nself urls

Print every service URL for your nSelf stack — API endpoints, console UIs, storage, email preview, and more — with automatic route conflict detection.

Quick start

# Print all URLs for the current environment
nself urls

# Filter to a specific category
nself urls --category api

# Open the Hasura console in your browser
nself urls --category hasura --open

# Copy the GraphQL endpoint to your clipboard
nself urls --category api --copy

# Output as JSON (for scripts)
nself urls --json

Synopsis

nself urls [FLAGS]

Description

nself urls reads your current environment configuration and prints every publicly reachable URL that nSelf exposes — internal service consoles, GraphQL endpoints, auth callbacks, storage browser, email preview, and any custom service endpoints you have configured.

The command also runs a lightweight route conflict check: if two services claim the same subdomain or nginx location block, it highlights the conflict so you can resolve it before traffic lands on the wrong backend. This check is especially useful after adding a new plugin or custom service.

By default it targets the current environment (local, staging, or prod — whichever is active in your.env cascade). Pass --env to query a different environment without switching.

Output

Each row shows the category, label, and full URL:

# nself urls
#
# CATEGORY     LABEL              URL
# api          GraphQL            https://api.local.nself.org/v1/graphql
# api          GraphQL (WS)       wss://api.local.nself.org/v1/graphql
# api          REST               https://api.local.nself.org/api/rest
# console      Hasura             https://api.local.nself.org/console
# auth         Auth               https://auth.local.nself.org
# auth         Auth (admin)       https://auth.local.nself.org/healthz
# storage      MinIO API          https://storage.local.nself.org
# storage      MinIO Console      https://storage.local.nself.org/minio/
# mail         Mailpit            https://mail.local.nself.org
# search       MeiliSearch        https://search.local.nself.org
# admin        Admin UI           http://localhost:3021
# custom       ping_api           https://ping.local.nself.org

Flags

URL categories

Examples

Get the GraphQL endpoint for a CI script

GRAPHQL=$(nself urls --category api --json --quiet | jq -r '.[0].url')
echo "Using $GRAPHQL"

Open the Hasura console

nself urls --category console --open

Check staging URLs without switching env

nself urls --env staging

Copy the auth endpoint for an .env file

nself urls --category auth --copy

Detect route conflicts after adding a plugin

nself urls --json | jq '[.[] | select(.conflict == true)]'

Route conflict detection

When two services expose the same nginx location or subdomain, nself urls marks the affected rows with a conflict: true flag in JSON output and prints a warning in text mode. Common causes include:

• Two plugins registering the same API path prefix
• A custom service (CS_N) using a subdomain already claimed by a required service
• A plugin port collision with an existing service (see the port registry)

Resolve conflicts by editing .env and running nself build to regenerate the nginx config.

Related

• nself status — overall stack health and version info
• nself health — probe individual endpoints
• nself service — enable or disable optional services
• nself build — regenerate nginx config and docker-compose