mirror of
https://codeberg.org/Cyborus/forgejo-cli.git
synced 2024-11-10 12:09:33 +01:00
improve readme
This commit is contained in:
parent
24ab090b55
commit
6f8c924498
1 changed files with 71 additions and 1 deletions
72
README.md
72
README.md
|
@ -2,7 +2,77 @@
|
||||||
|
|
||||||
CLI tool for interacting with Forgejo
|
CLI tool for interacting with Forgejo
|
||||||
|
|
||||||
# Licensing
|
## Installation
|
||||||
|
|
||||||
|
### Pre-built
|
||||||
|
|
||||||
|
Pre-built binaries are available for x86 Windows and Linux (GNU) on the
|
||||||
|
[releases tab](https://codeberg.org/Cyborus/forgejo-cli/releases/latest).
|
||||||
|
|
||||||
|
### From source
|
||||||
|
|
||||||
|
Install with `cargo install`
|
||||||
|
|
||||||
|
```
|
||||||
|
# Latest version
|
||||||
|
cargo install --git https://codeberg.org/Cyborus/forgejo-cli.git --tag v0.0.3
|
||||||
|
# From `main`
|
||||||
|
cargo install --git https://codeberg.org/Cyborus/forgejo-cli.git --branch main
|
||||||
|
```
|
||||||
|
|
||||||
|
### OCI Container
|
||||||
|
|
||||||
|
`forgejo-cli` is available as an OCI container for use in CI, at
|
||||||
|
`codeberg.org/cyborus/forgejo-cli:latest`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Instance-specific aliases
|
||||||
|
|
||||||
|
While you can just use the `fj` binary directly, it can be useful to alias it
|
||||||
|
with the `--host` flag set, to create shorthands for certain instances.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# For example, a `cb` command for interacting with codeberg
|
||||||
|
alias cb="fj --host codeberg.org"
|
||||||
|
# Or disroot
|
||||||
|
alias dr="fj --host git.disroot.org"
|
||||||
|
# Or any other instance you want!
|
||||||
|
# And the alias name can be whatever, as long as the `--host` flag is set.
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, when you reference a repository such as `forgejo/forgejo`, it will
|
||||||
|
implicitly get it from whichever alias you used!
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cb repo info forgejo/forgejo
|
||||||
|
forgejo/forgejo
|
||||||
|
> Beyond coding. We forge.
|
||||||
|
|
||||||
|
Primary language is Go
|
||||||
|
# etc...
|
||||||
|
```
|
||||||
|
|
||||||
|
When using `fj` directly, you'd have to use a URL to access it.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ fj repo info codeberg.org/forgejo/forgejo
|
||||||
|
forgejo/forgejo
|
||||||
|
> Beyond coding. We forge.
|
||||||
|
|
||||||
|
Primary language is Go
|
||||||
|
# etc...
|
||||||
|
|
||||||
|
# Notice the "dr", trying to access Disroot, still works when you specify Codeberg in the repository name!
|
||||||
|
$ dr repo info codeberg.org/forgejo/forgejo
|
||||||
|
forgejo/forgejo
|
||||||
|
> Beyond coding. We forge.
|
||||||
|
|
||||||
|
Primary language is Go
|
||||||
|
# etc...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Licensing
|
||||||
|
|
||||||
This project is licensed under either
|
This project is licensed under either
|
||||||
[Apache License Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT)
|
[Apache License Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT)
|
||||||
|
|
Loading…
Reference in a new issue