diff --git a/src/routes/ngit/+page.svelte b/src/routes/ngit/+page.svelte index ba037bb..1303ac6 100644 --- a/src/routes/ngit/+page.svelte +++ b/src/routes/ngit/+page.svelte @@ -6,79 +6,90 @@
- a command-line tool to create, list and apply PRs and patches to git - repositories via nostr events. + a command-line tool for managing git repositories change proposals via + nostr +
++ works seemlessly with gitworkshop.dev
- It is designed to work seemlessly with this site gitworkshop.dev.
- If you have cargo installed runcargo install ngit.
- Alternatively download:
+ until the release of v1.0.0 you will need to clone ngit-cli `main` branch
+ and build from source
add the binary to a directory from which it can be run globally.
++ add the following binary to a directory from which it can be run + globally: +
++ Linux + Mac + Windows TODO: issue v1.0.0 and activate these links +
+ +
+ alternatively, if you have cargo installed runcargo install ngit
+
All commands should be run from the directory of the git repository
+run from the directory of the git repository:
ngit prs createngit init - use this when you are on a feature branch to propose it gets merged into the - remote branch by repository maintainer. -
-- It creates a PR event and patch events for each commit that isn't also in - the main or master branch. + for maintainers to signal they are accepting proposals via nostr
+ngit prs listngit send - fetches a selectable list of open PRs and, if one is selected and the repository - is clean, will create a branch for it and apply the commits. If the branch - already exists it will pull any updates. + send commits on current branch as a proposal
ngit pullngit list - if the repository is currently in a branch related to an existing PR, it will - pull any updates from nostr. + list proposals; optionally apply them as a new branch
+and when on a proposal branch:
ngit push - if the repository is currently in a branch related to an existing PR, it will - create patch events for any new commits. + send new commits as proposal ammendments
ngit claimngit pull - issue a repository nostr event which lists it on gitworkshop.dev and indicates - you are accepting patches and PRs via nostr. This can be run many times to - update the details. The relays will reflect your user relays plus blaster. + fetch and apply new proposal commits
+- It also creates an optional maintainers.yaml file in the root of your repo that lists maintainers and relays. If commited - it will make it smoother for contributors to find your repository event and - also makes any future transfer of repository ownership easier. + ngit init + also creates an optional + maintainers.yaml file in the + root of your repo that lists maintainers and relays. If commited it will make + it smoother for contributors to find your repository event and also makes any + future transfer of repository ownership easier.