ThreeFold Flist CLI in V to turn Dockerfile+Docker Images into Flist on the TF Flist Hub
.gitignore | ||
flist.v | ||
LICENSE | ||
Makefile | ||
README.md |
Flist CLI in Vlang
Table of Contents
- Introduction
- Installation
- Usage
- Commands
- OS-Specific Instructions
- Troubleshooting
- Development
- Contributing
- License
Introduction
Flist CLI is a tool that turns Dockerfiles and Docker images directly into Flist on the TF Flist Hub, passing through Docker Hub.
Installation
Prerequisites
- V programming language (latest version) installed on your system
- Docker installed and running
- Docker Hub account
- TF Hub account and token
Building and Installing
Clone this repository, build the project, and install the CLI:
git clone https://git.ourworld.tf/tfgrid/flist_cli_v
cd flist_cli_v
make build
This will build the flist
executable and install it to the appropriate system location.
Rebuild and Uninstall
You can use the following Makefile commands:
-
To rebuild and reinstall:
make rebuild
-
To uninstall and remove the binary:
make delete
Usage
After installation, you can use the flist
command followed by various subcommands:
flist <command> [arguments]
Commands
install
: Install the Flist CLIuninstall
: Uninstall the Flist CLIlogin
: Log in to Docker Hub and save the Flist Hub tokenlogout
: Log out of Docker Hub and remove the Flist Hub tokenpush <image>:<tag>
: Build and push a Docker image, then convert and push it as an flistdelete <flist_name>
: Delete an flist from Flist Hubrename <flist_name> <new_flist_name>
: Rename an flist in Flist Hubls
: List all flists of the current userls url
: List all flists of the current user with full URLshelp
: Display help information
OS-Specific Instructions
Windows
- Run Command Prompt or PowerShell as Administrator.
- Ensure Docker Desktop is installed and running.
- Use a Docker-enabled terminal for all Docker-related commands.
- The
flist
executable will be installed to:C:\Program Files\flist\flist.exe
macOS and Linux
- Ensure Docker is installed and the Docker daemon is running.
- The
flist
executable will be installed to:/usr/local/bin/flist
Troubleshooting
- If you encounter permission issues, ensure you're running the command with appropriate privileges (e.g., as administrator on Windows or with
sudo
on Unix-like systems). - Make sure Docker is running before using Flist CLI commands.
- If you face issues with Docker commands, try logging out and logging back in to refresh your Docker credentials.
- If you encounter compilation errors, ensure you have the latest version of V installed.
Development
To modify the Flist CLI:
- Make your changes to the
flist.v
file. - Rebuild the project using
make rebuild
- Test your changes thoroughly across different operating systems if possible.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.