Nous CLI

Nous is a command-line tool for publishing static websites to the Nostr protocol and Blossom servers, based on NIP-XX: Pubkey Static Websites. It allows you to create and manage decentralized websites with cryptographic identities, secure key storage, and a user-friendly interface.

Features

• Decentralized Publishing: Host your static websites on a distributed network of Nostr relays and Blossom servers.
• Cryptographic Identity: Each project has a unique keypair, ensuring secure and verifiable ownership.
• Secure Storage: Private keys are stored securely in SQLite, never transmitted over the network.
• User-Friendly: Interactive prompts guide you through the publishing process.

Installation

Using npx (Recommended)

You can run Nous directly from npx without a global installation:

npx @soapbox.pub/nous publish ./my-website

Global Installation

Alternatively, you can install Nous globally using npm:

npm install -g @soapbox.pub/nous

Then, you can run the nous command directly:

nous publish ./my-website

Usage

publish

The publish command uploads your website to the Nostr network. When you run it for the first time, it will guide you through creating a new project and keypair.

nous publish <folder>

Options:

• --force: Republish all files, even if they haven't changed.
• --purge: Delete old file events before publishing.
• --verbose: Show detailed output and progress information.

configure

The configure command allows you to manage your default relays, Blossom servers, and other settings.

nous configure

Development

To contribute to the development of Nous, you'll need to have pnpm installed. Follow these steps to get started:

1. Clone the repository:

   git clone https://github.com/soapbox-pub/nous-cli.git

2. Install dependencies:

   pnpm install

3. Run the app with:

   pnpm start

License

This project is licensed under the MIT License. See the LICENSE.md file for details.