updated readme without sudo info"
This commit is contained in:
parent
3bfb44099d
commit
be04720d4c
14
README.md
14
README.md
@ -8,6 +8,7 @@
|
|||||||
- [Building and Installing](#building-and-installing)
|
- [Building and Installing](#building-and-installing)
|
||||||
- [Rebuild and Uninstall](#rebuild-and-uninstall)
|
- [Rebuild and Uninstall](#rebuild-and-uninstall)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
|
- [Commands](#commands)
|
||||||
- [OS-Specific Instructions](#os-specific-instructions)
|
- [OS-Specific Instructions](#os-specific-instructions)
|
||||||
- [Windows](#windows)
|
- [Windows](#windows)
|
||||||
- [macOS and Linux](#macos-and-linux)
|
- [macOS and Linux](#macos-and-linux)
|
||||||
@ -33,7 +34,7 @@ Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist
|
|||||||
|
|
||||||
### Building and Installing
|
### Building and Installing
|
||||||
|
|
||||||
1. Clone this repository, build the project, and install the CLI:
|
Clone this repository, build the project, and install the CLI:
|
||||||
```
|
```
|
||||||
git clone https://git.ourworld.tf/tfgrid/flist_cli_v
|
git clone https://git.ourworld.tf/tfgrid/flist_cli_v
|
||||||
cd flist_cli_v
|
cd flist_cli_v
|
||||||
@ -64,7 +65,8 @@ After installation, you can use the `flist` command followed by various subcomma
|
|||||||
flist <command> [arguments]
|
flist <command> [arguments]
|
||||||
```
|
```
|
||||||
|
|
||||||
Available commands:
|
## Commands
|
||||||
|
|
||||||
- `install`: Install the Flist CLI
|
- `install`: Install the Flist CLI
|
||||||
- `uninstall`: Uninstall the Flist CLI
|
- `uninstall`: Uninstall the Flist CLI
|
||||||
- `login`: Log in to Docker Hub and save the Flist Hub token
|
- `login`: Log in to Docker Hub and save the Flist Hub token
|
||||||
@ -72,6 +74,8 @@ Available commands:
|
|||||||
- `push <image>:<tag>`: Build and push a Docker image, then convert and push it as an flist
|
- `push <image>:<tag>`: Build and push a Docker image, then convert and push it as an flist
|
||||||
- `delete <flist_name>`: Delete an flist from Flist Hub
|
- `delete <flist_name>`: Delete an flist from Flist Hub
|
||||||
- `rename <flist_name> <new_flist_name>`: Rename an flist in Flist Hub
|
- `rename <flist_name> <new_flist_name>`: Rename an flist in Flist Hub
|
||||||
|
- `ls`: List all flists of the current user
|
||||||
|
- `ls url`: List all flists of the current user with full URLs
|
||||||
- `help`: Display help information
|
- `help`: Display help information
|
||||||
|
|
||||||
## OS-Specific Instructions
|
## OS-Specific Instructions
|
||||||
@ -93,12 +97,6 @@ Available commands:
|
|||||||
```
|
```
|
||||||
/usr/local/bin/flist
|
/usr/local/bin/flist
|
||||||
```
|
```
|
||||||
3. You may need to use `sudo` for installation and certain operations:
|
|
||||||
```
|
|
||||||
sudo make build
|
|
||||||
sudo make rebuild
|
|
||||||
sudo make delete
|
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user