Skip to content

Commit

Permalink
forgot the readme (again) - should really automate this
Browse files Browse the repository at this point in the history
  • Loading branch information
rarescosma committed Oct 15, 2024
1 parent 2b4b694 commit 4b4ff7e
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ sudo trust anchor ~/.mitmproxy/mitmproxy-ca-cert.cer

```
# octotail --help
Usage: octotail [OPTIONS] COMMIT_SHA
Look for an active workflow run for the given <COMMIT_SHA> (and optionally --workflow-name and/or
Look for an active workflow run for the given <COMMIT_SHA> (and optionally --workflow and/or
--ref-name) and attempt to tail its logs.
NOTE: the <COMMIT_SHA> has to be of the full 40 characters length.
Expand All @@ -109,19 +109,23 @@ sudo trust anchor ~/.mitmproxy/mitmproxy-ca-cert.cer
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ * --gh-pat TEXT GitHub personal access token. [env var: _GH_PAT] │
│ * --gh-pat TEXT GitHub personal access token. (for API auth) │
│ [env var: _GH_PAT] │
│ [required] │
│ * --gh-user TEXT GitHub username. (for web auth) [env var: _GH_USER] │
│ [required] │
│ * --gh-pass TEXT GitHub password. (for web auth) [env var: _GH_PASS] │
│ [required] │
│ --gh-otp TEXT GitHub OTP. (for web auth) [env var: _GH_OTP] │
│ [default: None] │
│ --workflow -w TEXT Look for workflows with this particular name. │
│ [default: None] │
│ --ref-name -r TEXT Look for workflows triggered by this ref. │
│ --workflow -w TEXT Only consider workflows with this name. │
│ --ref-name -r TEXT Only consider workflows triggered by this ref. │
│ Example: 'refs/heads/main' │
│ [default: None] │
│ --repo -R TEXT Use this GitHub repo to look for workflow runs. If │
│ unspecified, will look for a remote matching │
│ 'git@github.com:<user>/<repo>.git' in the current │
│ directory. │
│ Examples: 'user/repo' OR 'org_name/repo' │
│ --headless --no-headless [env var: _HEADLESS] [default: headless] │
│ --port INTEGER [env var: _PORT] │
│ [default: (random in range 8100-8500)] │
Expand Down

0 comments on commit 4b4ff7e

Please sign in to comment.