Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mszostok committed Jul 25, 2024
0 parents commit c996ee5
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Fuse

The ultimate AI assistant for Platform Engineers, crafted by the Botkube Team.

![Using fuse in CLI](docs/assets/prompt.gif)

## Installation

### macOS & Linux

Fuse is available via [Homebrew](https://brew.sh) and as a downloadable binary from the [releases page](https://github.com/kubeshop/fuse-releases/releases).

#### Homebrew

| Install | Upgrade |
|--------------------------------------------|--------------------------------------------|
| `brew install kubeshop/fuse-releases/fuse` | `brew upgrade kubeshop/fuse-releases/fuse` |


<details><summary><strong>Using <code>curl</code> on Linux</strong></summary>
<p>


Download the Fuse CLI binary and move it to a directory in your `$PATH`:

```shell
curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-linux-amd64
chmod +x fuse && mv fuse /usr/local/bin/fuse
```

> [!NOTE]
> You may need to use sudo to run the mv command as it moves the binary file to the `/usr/local/bin/` directory.
</p>
</details>

### Windows

Use [curl](https://curl.se/windows/) to download the Fuse CLI binary:

```shell
curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-windows-amd64.exe
```

Move the binary to a directory in your `%PATH%`.

<details><summary><strong>Other Platforms</strong></summary>
<p>


Download the Fuse CLI binary and move it to a directory in your `$PATH`/`%PATH%`:

```shell
export OS=<your-os> # allowed values: darwin, linux, windows
export ARCH=<your-arch> # allowed values: amd64, arm64, armv7
export SUFFIX="" # set to ".exe" if OS is 'windows'
curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-${OS}-${ARCH}${SUFFIX}
chmod +x fuse && mv fuse /usr/local/bin/fuse
```

</p>
</details>

## Getting Started

After downloading the CLI, you can start experimenting right away:

```shell
fuse list my GKE instances and their status
```
Binary file added docs/assets/prompt.gif
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 c996ee5

Please sign in to comment.