reya/n34
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update commands help messages

Browse Source 
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb
2025-08-24 09:24:31 +00:00
parent 089b62a0ef
commit c308dc1b42
42 changed files with 203 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/issue/close.md
View File

@@ -12,7 +12,7 @@ Arguments:
<ISSUE_ID> The open issue id to close it
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1632` (Close status) for the specified issue. The issue have to

2
docs/issue/list.md
View File

@@ -9,7 +9,7 @@ List the repositories issues
Usage: n34 issue list [OPTIONS] [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`
[NADDR-NIP05-OR-SET]... Repository addresses
Options:
--limit <LIMIT> Maximum number of issues to list [default: 15]

2
docs/issue/new.md
View File

@@ -9,7 +9,7 @@ Create a new repository issue
Usage: n34 issue new [OPTIONS] <--content <CONTENT>|--editor>
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
-c, --content <CONTENT> Markdown content for the issue. Cannot be used together with the `--editor` flag
-e, --editor Opens the user's default editor to write issue content. The first line will be used as the issue subject
--subject <SUBJECT> The issue subject. Cannot be used together with the `--editor` flag

2
docs/issue/reopen.md
View File

@@ -12,7 +12,7 @@ Arguments:
<ISSUE_ID> The ID of the closed issue to reopen
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1630` (Open status) for the specified issue. The issue have to

2
docs/issue/resolve.md
View File

@@ -12,7 +12,7 @@ Arguments:
<ISSUE_ID> The issue id to resolve it
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1631` (Resolved status) event for the specified issue.

2
docs/issue/view.md
View File

@@ -12,7 +12,7 @@ Arguments:
<ISSUE_ID> The issue id to view it
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Simply provide the issue ID in `note` or `nevent` format to retrieve and display

2
docs/patch/apply.md
View File

@@ -13,7 +13,7 @@ Arguments:
[APPLIED_COMMITS]... The applied commits
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
--patches <PATCH-EVENT-ID> Patches that have been applied. Use this when only some patches have been applied, not all
```

2
docs/patch/close.md
View File

@@ -12,7 +12,7 @@ Arguments:
<PATCH_ID> The open/drafted patch id to close it. Must be orignal root patch
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1632` (Close status) for the specified patch. The patch have to

2
docs/patch/draft.md
View File

@@ -12,7 +12,7 @@ Arguments:
<PATCH_ID> The open patch id to draft it. Must be orignal root patch
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1633` (Draft status) for the specified patch. The patch have to

2
docs/patch/fetch.md
View File

@@ -12,7 +12,7 @@ Arguments:
<PATCH_ID> The patch id to fetch it
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
-o, --output <PATH> Output directory for the patches. Default to the current directory
```

2
docs/patch/list.md
View File

@@ -9,7 +9,7 @@ List the repositories patches
Usage: n34 patch list [OPTIONS] [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`
[NADDR-NIP05-OR-SET]... Repository addresses
Options:
--limit <LIMIT> Maximum number of patches to list [default: 15]

2
docs/patch/merge.md
View File

@@ -13,7 +13,7 @@ Arguments:
<MERGE_COMMIT> The merge commit id
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
--patches <PATCH-EVENT-ID> Patches that have been merged. Use this when only some patches have been merged, not all
```

2
docs/patch/reopen.md
View File

@@ -12,7 +12,7 @@ Arguments:
<PATCH_ID> The closed/drafted patch id to reopen it. Must be orignal root patch
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Issue a kind `1632` (Close status) for the specified patch. The patch have to

2
docs/patch/send.md
View File

@@ -12,7 +12,7 @@ Arguments:
<PATCH-PATH>... List of patch files to send (space separated)
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
--original-patch <EVENT-ID> Original patch ID if this is a revision of it
```

2
docs/reply.md
View File

@@ -13,7 +13,7 @@ Arguments:
Options:
--quote-to Quote the replied-to event in the editor
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
-c, --comment <COMMENT> The comment (cannot be used with --editor)
-e, --editor Open editor to write comment (cannot be used with --content)
```

2
docs/repo/state.md
View File

@@ -12,7 +12,7 @@ Arguments:
<HEAD> Name of the repository's primary branch, such as 'master' or 'main'
Options:
--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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
--tags <TAGS> Tags to announce a state for, in the format `<tag-name>=<commit-id>`. Separated by comma
--branches <BRANCHES> Branches to announce a state for, in the format `<branch-name>=<commit-id>`. Separated by comma
```

2
docs/repo/view.md
View File

@@ -9,7 +9,7 @@ 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`
[NADDR-NIP05-OR-SET]... Repository addresses
```
This command prints repository details to standard output. If no arguments

2
docs/sets/new.md
View File

@@ -13,7 +13,7 @@ Arguments:
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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Each set requires a unique name, provided as the final argument to the command.

2
docs/sets/remove.md
View File

@@ -13,7 +13,7 @@ Arguments:
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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
```
Removes an entire set, or specific repositories and relays from it.

2
docs/sets/update.md
View File

@@ -13,7 +13,7 @@ Arguments:
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`
--repo <NADDR-NIP05-OR-SET> Repository addresses
--override Replace existing relays/repositories instead of adding to them
```