Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
igolaizola committed Jun 27, 2024
1 parent b14c946 commit f0187d0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# webcli
# webcli 🌐🖥️

**webcli** is a tool to generate an automatic web UI on top of a CLI
**webcli** is a tool to generate an automatic web UI on top of a Golang CLI

## Features
<p align="center"><img src="webcli.png" width="300"></p>

## 🚀 Features

- List all commands and subcommands
- Edit the flags of the commands using input fields
Expand All @@ -12,22 +14,28 @@
- Load command flags from configuration files
- Save command flags to configuration files

## Compatibility
## 🔌 Compatibility

The tool is directly compatible with `github.com/peterbourgon/ff/v3` and `github.com/spf13/cobra` libraries, using `github.com/igolaizola/webcli/pkg/webff` and `github.com/igolaizola/webcli/pkg/webcobra` respectively.

You can also directly use the `github.com/igolaizola/webcli` package and pass your commands as `webcli.Command` to the `webcli.New` function.

## Usage
## 🕹️ Usage

You can find an example using an `ff` CLI at `cmd/webff/main.go`, which you can run with:
You can find an example using an `ff` CLI at [cmd/webff/main.go](cmd/webff/main.go), which you can run with:

```bash
go run cmd/webff/main.go
```

You can find an example using a `cobra` CLI at `cmd/webcobra/main.go`, which you can run with:
You can find an example using a `cobra` CLI at [cmd/webcobra/main.go](cmd/webcobra/main.go), which you can run with:

```bash
go run cmd/webcobra/main.go
```

## 💖 Support

Please give the repository a star ⭐ if you have found this code helpful.

For any questions, create an issue or ping me at [x.com/igolaizola](https://x.com/igolaizola).
Binary file added webcli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f0187d0

Please sign in to comment.