4
docs/repo/README.md
Normal file
4
docs/repo/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# Manage Repositories
|
||||
|
||||
In `n34` you can manage your repositories. This includes announcing new ones,
|
||||
viewing existing ones, and announcing state updates (coming soon).
|
||||
32
docs/repo/announce.md
Normal file
32
docs/repo/announce.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Broadcast and Update a Git Repository
|
||||
|
||||
> `n34 repo announce` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Publish information about a git repository to Nostr for collaboration and feedback. Can also be used to update an existing repository's details
|
||||
|
||||
Usage: n34 repo announce [OPTIONS] --id <REPO_ID>
|
||||
|
||||
Options:
|
||||
--id <REPO_ID> Unique identifier for the repository in kebab-case
|
||||
-n, --name <NAME> A name for the repository
|
||||
-d, --description <DESCRIPTION> A description for the repository
|
||||
-w, --web <WEB> Webpage URLs for the repository (if provided by the git server)
|
||||
-c, --clone <CLONE> URLs for cloning the repository
|
||||
-m, --maintainers <MAINTAINERS> Additional maintainers of the repository (besides yourself)
|
||||
-l, --label <LABEL> Labels to categorize the repository. Can be specified multiple times
|
||||
--force-id Skip kebab-case validation for the repository ID
|
||||
--address-file If set, creates a `nostr-address` file to enable automatic address discovery by n34
|
||||
```
|
||||
|
||||
This command generates an announcement event to publish your project. It can be
|
||||
used to announce a new repository or update an existing one.
|
||||
|
||||
When updating, you must resubmit all repository fields, not just the fields
|
||||
you wish to change. The command uses this information to build and publish a
|
||||
completely new announcement event that will replace the old one.
|
||||
|
||||
It is recommended to use the `--address-file` flag. This option creates
|
||||
a `nostr-address` file that enables `n34` to automatically discover the
|
||||
repository's address, simplifying the workflow for contributors.
|
||||
20
docs/repo/view.md
Normal file
20
docs/repo/view.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# View Git Repository Details
|
||||
|
||||
> `n34 repo view` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
View details of a nostr git repository
|
||||
|
||||
Usage: n34 repo view [NADDR-NIP05-OR-SET]...
|
||||
|
||||
Arguments:
|
||||
[NADDR-NIP05-OR-SET]... Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
|
||||
```
|
||||
|
||||
This command prints repository details to standard output. If no arguments
|
||||
are provided, it looks for a `nostr-address` file in the current directory
|
||||
and displays the details for the address specified within it. See [passing
|
||||
repositories] for details on accepted formats.
|
||||
|
||||
[passing repositories]: /commands.html#passing-repositories
|
||||
Reference in New Issue
Block a user