Skip to content

Commit

Permalink
document running octotail through uvx
Browse files Browse the repository at this point in the history
  • Loading branch information
rarescosma committed Oct 16, 2024
1 parent 80266c1 commit 98ea64a
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,55 @@ workers.
The headless browser tabs are cleaned up immediately after the WebSocket
extraction, so the overhead is minimal. (well, it's still an empty browser)

## Installation

### Pre-install
## Prerequisites

- python 3.12
- a working chromium-based browser under `/usr/bin/chromium`

Make sure `/usr/bin/chromium` points to a working chromium-based browser.

If unsure, and on Arch:
If unsure, and on Arch Linux:

```shell
paru ungoogled-chromium-bin
```

## Installation

### Via `uvx`

One can simply and hassle-free invoke `octotail` through [uvx][].

First, generate the proxy root certificate:

```shell
uvx --from=octotail generate-cert
```

Then, see [Install the generated proxy root certificate](#install-the-generated-proxy-root-certificate)
for instructions on how to install the generated certificate on your platform.

Finally, simply invoke it via:

```shell
uvx --from=octotail octotail --help
```

Or alias it as `octotail`:

```shell
# change .zshrc to .bashrc, config.fish, etc. if needed
echo "alias octotail='uvx --from octotail octotail'" >> ~/.zshrc
```

### Pypi package

```shell
mkdir octotail && cd octotail
python3 -mvenv .venv && source .venv/bin/activate
pip3 install octotail

# or .bashrc, config.fish, etc.
# change .zshrc to .bashrc, config.fish, etc.
echo "alias octotail='$(pwd)/.venv/bin/python3 $(pwd)/.venv/bin/octotail'" >> ~/.zshrc
```

Expand Down Expand Up @@ -226,5 +252,5 @@ git push proxy

[Codecrafters]: https://codecrafters.io/
[mitmproxy]: https://mitmproxy.org/
[uv & uvx]: https://github.com/astral-sh/uv
[uvx]: https://github.com/astral-sh/uv
["Installing the mitmproxy CA certificate manually"]: https://docs.mitmproxy.org/stable/concepts-certificates/#installing-the-mitmproxy-ca-certificate-manually

0 comments on commit 98ea64a

Please sign in to comment.