11
docs/sets/README.md
Normal file
11
docs/sets/README.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Managing Repository and Relay Sets
|
||||
|
||||
Sets are a convenience feature for contributing to projects that do not have a
|
||||
`nostr-address` file. Instead of manually specifying the project's repositories
|
||||
and relays for every command, you can define them once as a named "set". You can
|
||||
then reference this set by its name in commands. This allows you to use the set
|
||||
as a shortcut for a list of relays (`--relays <set_name>`) or as the project's
|
||||
address in commands like `issue` and `patch`.
|
||||
|
||||
Sets are defined in your configuration file. To use a specific configuration
|
||||
file, pass its path using the `--config` option.
|
||||
25
docs/sets/new.md
Normal file
25
docs/sets/new.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Create a Set
|
||||
|
||||
> `n34 sets new` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Create a new set
|
||||
|
||||
Usage: n34 sets new [OPTIONS] <NAME>
|
||||
|
||||
Arguments:
|
||||
<NAME> Unique name for the set
|
||||
|
||||
Options:
|
||||
--set-relay <RELAYS> Optional relay to add it to the set, either as URL or set name to extract its relays. [aliases: `--sr`]
|
||||
--repo <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`
|
||||
```
|
||||
|
||||
Each set requires a unique name, provided as the final argument to the command.
|
||||
Use the `--set-relays`/`--sr` option to specify the relays for the new set;
|
||||
this can be a relay URL or the name of an existing set whose relays you wish to
|
||||
use. To add repositories, use the `--repo` option. Check [passing repositories]
|
||||
format.
|
||||
|
||||
[passing repositories]: /commands.html#passing-repositories
|
||||
24
docs/sets/remove.md
Normal file
24
docs/sets/remove.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Remove a Set
|
||||
|
||||
> `n34 sets remove` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Remove a set, or specific repos and relays within it
|
||||
|
||||
Usage: n34 sets remove [OPTIONS] <NAME>
|
||||
|
||||
Arguments:
|
||||
<NAME> Set name to delete
|
||||
|
||||
Options:
|
||||
--set-relay <RELAYS> Specific relay to remove it from the set, either as URL or set name to extract its relays. [aliases: `--sr`]
|
||||
--repo <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`
|
||||
```
|
||||
|
||||
Removes an entire set, or specific repositories and relays from it.
|
||||
Without options, this command deletes the entire set.
|
||||
|
||||
See the [passing repositories] section for more details on supported formats.
|
||||
|
||||
[passing repositories]: /commands.html#passing-repositories
|
||||
17
docs/sets/show.md
Normal file
17
docs/sets/show.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Show a Set
|
||||
|
||||
> `n34 sets show` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Show a single set or all the stored sets
|
||||
|
||||
Usage: n34 sets show [NAME]
|
||||
|
||||
Arguments:
|
||||
[NAME] Name of the set to display. If not provided, lists all available sets
|
||||
```
|
||||
|
||||
Prints all set names to standard output, each followed by its associated repos
|
||||
and relays. To view the details for a specific set, provide its name as an
|
||||
argument.
|
||||
25
docs/sets/update.md
Normal file
25
docs/sets/update.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Modify a Set
|
||||
|
||||
> `n34 sets update` command
|
||||
|
||||
**Usage:**
|
||||
```
|
||||
Modify an existing set
|
||||
|
||||
Usage: n34 sets update [OPTIONS] <NAME>
|
||||
|
||||
Arguments:
|
||||
<NAME> Name of the set to update
|
||||
|
||||
Options:
|
||||
--set-relay <RELAYS> Add relay to the set, either as URL or set name to extract its relays. [aliases: `--sr`]
|
||||
--repo <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`
|
||||
--override Replace existing relays/repositories instead of adding to them
|
||||
```
|
||||
|
||||
Use this command to update an existing set by its name. By default, providing
|
||||
relays via `--set-relay` or repositories via `--repo` will add them to the set's
|
||||
existing entries. To replace the current relays and repositories with the new
|
||||
values, use the `--override` flag.
|
||||
|
||||
[passing repositories]: /commands.html#passing-repositories
|
||||
Reference in New Issue
Block a user