naskya/fishctl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README

Browse source
This commit is contained in:
naskya 2024-07-01 10:22:55 +09:00
parent 258c00b84c
commit 528d725cf8
Signed by: naskya
GPG key ID: 712D413B3A9FED5C
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,4 +1,4 @@
# Firefish CLI tool
# CLI tool for Firefish
## Install and Update
@ -9,45 +9,45 @@
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
# Install pre-built executable
cargo binstall --locked --git https://firefish.dev/firefish/firefish-cli.git
cargo binstall --git https://firefish.dev/firefish/fishctl.git
```
You can update the package using the same command.
```sh
cargo binstall --locked --git https://firefish.dev/firefish/firefish-cli.git
cargo binstall --git https://firefish.dev/firefish/fishctl.git
```
### Download pre-built executable file
You can also download the pre-built executable file from the [release page](https://firefish.dev/firefish/firefish-cli/-/releases), but you need to manage/update the file on your own.
You can also download the pre-built executable file from the [release page](https://firefish.dev/firefish/fishctl/-/releases), but you need to manage/update the file on your own.
### Install from source
```sh
# Build from source
cargo install --locked --git https://firefish.dev/firefish/firefish-cli.git
cargo install --locked --git https://firefish.dev/firefish/fishctl.git
```
You can update the package using the same command.
```sh
cargo install --locked --git https://firefish.dev/firefish/firefish-cli.git
cargo install --locked --git https://firefish.dev/firefish/fishctl.git
```
### Use pre-built OCI image
Using the `registry.firefish.dev/firefish/firefish-cli` container image, `fishctl ___` commands can be executed as
Using the `registry.firefish.dev/firefish/fishctl` container image, `fishctl ___` commands can be executed as
```sh
docker run -it --rm --volume "$(pwd)":/firefish --network network_name \
registry.firefish.dev/firefish/firefish-cli \
registry.firefish.dev/firefish/fishctl \
fishctl ___
# or
podman run -it --rm --volume "$(pwd)":/firefish --network network_name \
registry.firefish.dev/firefish/firefish-cli \
registry.firefish.dev/firefish/fishctl \
fishctl ___
```