irongit

Git hosting and a container registry in one Rust binary (axum + Astro)

README: CLI usage and test commands

huncholanehuncholaneauthored
parent 5886a21commit cf03afbc35182cc0641f242c311e33a4b93f0c31Browse files

1 file changed, +24 -0

+24-0README.md
@@ -56,6 +56,30 @@ Publish a CLI build so `install.sh` and `ig upgrade` serve it:
5656 irongit admin publish-cli target/x86_64-unknown-linux-musl/release/ig --version 0.1.0
5757 ```
5858
59+## The ig CLI
60+
61+```sh
62+curl -fsSL http://localhost:7878/install.sh | sh # installs ig and docker-credential-ig
63+ig login # approve in the browser; sets up git and docker helpers
64+ig repo create api --private
65+ig repo clone you/api
66+docker push localhost:7878/you/api:1.0
67+ig image visibility you/api public
68+ig ssh-key add # ~/.ssh/id_ed25519.pub by default
69+ig upgrade
70+```
71+
72+Full reference at `/docs/cli`; git, SSH and LFS at `/docs/git`; the
73+registry at `/docs/registry`.
74+
75+## Tests
76+
77+```sh
78+cargo test --workspace # unit tests (server, CLI, shared types)
79+scripts/e2e/ssh-lfs.sh # SSH, LFS end to end against a running server
80+scripts/e2e/backup.sh # backup to R2 and restore every bundle
81+```
82+
5983 ## Layout
6084
6185 ```