ngit nsite publish
publish a directory as a root or named NIP-5A static site
Parent command: ngit nsite
Related guide: Publication guides
Preview command surface
This page is generated from a tagged ngit prerelease. Test it before relying on it in production.
Usage
text
Usage: ngit nsite publish [OPTIONS] <DIRECTORY>Arguments and options
| Input | Description | Details |
|---|---|---|
<DIRECTORY> | Directory containing already-built static assets | required |
--config <PATH> | Read nsyte-compatible defaults from this JSON file | conflicts with --no-config |
--no-config | Ignore .nsite/config.json | conflicts with --config <PATH> |
--id, --name <ID> | Publish a named site with this identifier; omit for the root site | — |
--title <TEXT> | Human-readable site title | — |
--description <TEXT> | Short site description | conflicts with --description-file <PATH> |
--description-file <PATH> | Read the site description from a file | conflicts with --description <TEXT> |
--source <URL> | Source repository or archive URL (https:// or nostr://) | — |
--fallback <SITE_PATH> | Map this build-output path to /404.html | — |
--blossom-server <URL> | Override kind-10063 discovery with a Blossom server (repeatable) | repeatable |
--relay <URL> | Extend manifest discovery and publication with a relay (repeatable) | repeatable |
--concurrency <N> | Maximum simultaneous Blossom presence checks and uploads | default 4 |
-n, --nsec <NSEC> | nsec or hex private key | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--nsec-file <PATH> | read an nsec or hex private key from a path resolving to a regular file | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, -n, --nsec <NSEC>, --signer <NPUB|ALIAS|NAME> |
--nbunksec <NBUNKSEC> | established remote signer connection encoded as nbunksec | global; conflicts with --nbunksec-file <PATH>, -n, --nsec <NSEC>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--nbunksec-file <PATH> | read an nbunksec connection from a path resolving to a regular file | global; conflicts with --nbunksec <NBUNKSEC>, -n, --nsec <NSEC>, --nsec-file <PATH>, --signer <NPUB|ALIAS|NAME> |
--signer <NPUB|ALIAS|NAME> | use a configured signer by npub, alias, or cached profile name for this command | global; conflicts with --nbunksec <NBUNKSEC>, --nbunksec-file <PATH>, -n, --nsec <NSEC>, --nsec-file <PATH> |
-c, --customize | show customization options via git config | global |
-d, --defaults | Use default values without prompting (non-interactive mode) | global; conflicts with -i, --interactive |
-i, --interactive | Enable interactive prompts (default behavior) | global; conflicts with -d, --defaults, --json |
-f, --force | Force operations, bypass safety guards | global |
-q, --quiet | Suppress progress and other non-essential output | global; conflicts with -v, --verbose |
-v, --verbose | Enable verbose output | global; conflicts with -q, --quiet |
--repo-relay-only | Only publish nostr events to repository relays, not user or default relays | global |
--repo <REMOTE|NADDR|NOSTR-URL> | Target repository for repo-scoped operations. Accepts a configured nostr:// remote name, an naddr, or a nostr:// URL. Overrides nostr.repo, tracked-upstream, and remote-based auto-detection. Available at any command position: ngit --repo upstream send ngit issue --repo upstream create ngit issue create --repo upstream | global |
--json | Output one machine-readable JSON document on stdout | global; conflicts with -i, --interactive |
-h, --help | Print help (see a summary with '-h') | — |
-V, --version | Print version | — |