Command Reference¶

nsyte provides a comprehensive set of commands for managing nostr sites. Each command is documented in detail on its own page.

Core Commands¶

Project Management¶

nsyte init — Initialize a new nsyte project with configuration
nsyte config — Interactive configuration editor
nsyte validate — Validate your nsyte configuration file

File Operations¶

nsyte deploy — Deploy files to nostr relays and blossom servers
nsyte sites — List all published sites for a pubkey
nsyte ls — List published files
nsyte browse — Interactive TUI browser for managing files
nsyte download — Download published files
nsyte purge — Remove published files

Development¶

nsyte serve — Serve files locally for development
nsyte run — Run resolver server with npub subdomains
nsyte debug — Debug nsites by checking relays and servers
nsyte announce — Publish app handler events

Authentication¶

nsyte bunker — Manage NIP-46 bunker connections
nsyte ci — Generate CI/CD credentials (nbunksec)

Legacy¶

nsyte upload — DEPRECATED: Use deploy instead

Global Options¶

These options are available for all commands:

--help — Show help information
--version — Show version information
-c, --config <path> — Path to config file (default: .nsite/config.json)

Authentication Options¶

Many commands support unified authentication:

--sec <secret> — Secret for signing (auto-detects format: nsec, nbunksec, bunker://, or 64-char hex)

The --sec flag automatically detects the format of your secret: - nsec1... - Nostr private key (bech32) - nbunksec... - Encoded bunker credentials
- bunker://... - Bunker URL with relay and optional secret - 64-character hex string - Raw private key

If not provided, commands will use the bunker configured in .nsite/config.json or prompt for authentication.

Configuration¶

nsyte uses a configuration file at .nsite/config.json which can store:

Default relays
Default blossom servers
Bunker connections
Project metadata

Use nsyte init to create a new configuration or nsyte validate to check an existing one.

Environment Variables¶

LOG_LEVEL — Logging level: none, error, warn, info, debug (default: info)
NSITE_DISPLAY_MODE — Display mode: interactive, non-interactive, debug (default: interactive)
NSYTE_DISABLE_KEYCHAIN — Disable native keychain, use encrypted file storage (set to true)
NSYTE_TEST_MODE — Enable test mode, disables keychain (set to true)
NSYTE_FORCE_ENCRYPTED_STORAGE — Force encrypted file storage instead of OS keychain (set to true)

Getting Started¶

Initialize a new project:
```
nsyte init
```
Deploy your site:
```
nsyte deploy ./dist
```
View your published files:
```
nsyte browse
```

Common Workflows¶

Publishing a Website¶

# Initialize project
nsyte init

# Deploy files
nsyte deploy ./dist --publish-profile --publish-relay-list

# Verify deployment
nsyte ls

Managing Files¶

# Interactive file browser
nsyte browse

# List files in terminal
nsyte ls

# Remove specific files
nsyte purge --paths "*.old" --include-blobs

CI/CD Integration¶

# Generate CI credentials
nsyte ci

# Use in CI pipeline
nsyte deploy ./dist --sec $NSYTE_NBUNKSEC