From 00e130929f7cb8ec8e5a40dbd01e12332d62bf54 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Fri, 11 Oct 2024 03:23:47 -0400 Subject: [PATCH] updated readme --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ab99d23..e799e35 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ - [Installation](#installation) - [Prerequisites](#prerequisites) - [Building and Installing](#building-and-installing) - - [Rebuild and Uninstall](#rebuild-and-uninstall) + - [Rebuilding and Uninstalling](#rebuilding-and-uninstalling) +- [Available Commands](#available-commands) - [Usage](#usage) - [OS-Specific Instructions](#os-specific-instructions) - [Linux](#linux) @@ -51,7 +52,7 @@ Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist This will build the executable and install it to the appropriate system location. -### Rebuild and Uninstall +### Rebuilding and Uninstalling You can use the following Makefile commands: @@ -75,7 +76,7 @@ You can use the following Makefile commands: make delete-win ``` -## Usage +## Available Commands After installation, you can use the `flist` command followed by various subcommands: @@ -85,6 +86,34 @@ flist [arguments] Run `flist` or `flist help` to see all available commands for your specific OS. +- `install` - Install the Flist CLI +- `uninstall` - Uninstall the Flist CLI +- `login` - Log in to Docker Hub and save the Flist Hub token +- `logout` - Log out of Docker Hub and remove the Flist Hub token +- `push` - Build and push a Docker image to Docker Hub, then convert and push it as an Flist to Flist Hub +- `delete` - Delete an Flist from Flist Hub +- `rename` - 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 this help message + +## Usage + +A Linux user would use the following commands: + +``` +sudo ./flist install +sudo flist uninstall +flist login +flist logout +flist push : +flist delete +flist rename +flist ls +flist ls url +flist help +``` + ## OS-Specific Instructions ### Linux