list

Aliases: ls — nsyte ls is equivalent to nsyte list.

List the files recorded in a site's published manifest for a given public key, rendered as a tree. Optionally filter by path.

Usage

bash

nsyte list [path] [options]   # canonical
nsyte ls   [path] [options]   # alias

[path] — Optional path filter. Can be a directory (e.g., docs/) or specific file (e.g., docs/index.html)

-r, --relays <relays> — The nostr relays to use (comma-separated). If not specified, uses relays from project config or default discovery relays
--sec <secret> — Secret for signing (auto-detects: nsec, nbunksec, bunker://, hex)
--prompt-sec — Prompt for the signing secret at runtime instead of --sec (keeps it out of shell history)
-p, --pubkey <npub> — The public key to list files for (npub, hex, or NIP-05)
-d, --name <name> — Site identifier for named sites. If not provided, lists root site
--use-fallback-relays — Include default nsyte relays in addition to configured relays
--use-fallbacks — Enable all fallback options (relays)

List files using project config:

bash

nsyte ls

List files for a specific public key:

bash

nsyte ls --pubkey npub1... --relays wss://relay.example

List files in a specific directory:

bash

nsyte ls docs/

List a specific file:

bash

nsyte ls docs/index.html

List files from a named site:

bash

nsyte ls -d blog

Use fallback relays for better discovery:

bash

nsyte ls --use-fallbacks

The ls command supports multiple authentication methods:

Explicit pubkey - Use --pubkey to list files for any public key (no signing required)
Unified secret - Use --sec with any supported format (nsec, nbunksec, bunker://, hex)
Project bunker - Uses the bunker configured in .nsite/config.json
Project config - If no pubkey or secret is given, the public key is resolved from the bunker or key configured in .nsite/config.json

Inherits global options. See global options.