RepoTrek

https://github.com/yuna-r/repotrek
Admin
RepoTrek is a terminal-first GitHub source browser designed for reading and exploring repositories...
Tokens:1,294
Snippets:13
Trust Score:3.4
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Verify Development Build

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

Run the verification script to ensure the build is functioning correctly.

```bash
./scripts/verify.sh
```

--------------------------------

### Build RepoTrek from Source

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

Commands to clone the repository and build the project using Cargo. Requires Rust 1.97 or later.

```bash
git clone https://github.com/yuna-r/repotrek.git
cd repotrek
cargo build --release
```

--------------------------------

### Run RepoTrek

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

Commands to launch the application on different operating systems.

```bash
./repotrek
```

```bash
./repotrek
```

```powershell
.\repotrek.exe
```

--------------------------------

### RepoTrek Keyboard Shortcuts

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

A comprehensive list of keyboard shortcuts for navigating the Home screen, Repository views, Readers, Palettes, Mouse interactions, and Global commands.

```text
Home
  Enter              open exact owner/repo or search
  Up/Down, Tab       move through sections and items
  PageUp/PageDown    move by page
  Home/End           first/last item
  F5, Ctrl+R, r      force online ETag revalidation
  F8, c              cache manager
  Esc                clear input; quit when input is empty

Repository
  Left/Right, h/l, Tab  switch tabs
  1..6                 Code / Commits / PR / Issues / Actions / Releases
  Up/Down, PageUp/Down move by item/page
  Enter                open the selected item inside RepoTrek
  o                    open the selected GitHub link in a browser
  Esc, u, ..           parent directory/back
  B                    switch branch
  f                    recursive file finder
  s, /                 repository-wide source search; Esc/Ctrl+C cancels
  [ or ]                previous/next PR or Issue state filter
  O / C / A             show Open / Closed / All PRs or Issues
  F5, r                force-revalidate the current view

Readers
  Up/Down, PageUp/Down move by line/page
  Home/g, End/G        first/last line
  Left/Right, h/l      horizontal scroll
  Shift+J/K            extend line selection
  Ctrl+A / Shift+A     select all
  y / Ctrl+C           copy selection
  Esc                  clear selection before leaving
  v                    start/clear selection
  w                    toggle wrapping
  Tab                  Code / Blame / History in a source file
  / / Ctrl+F           Find in the current file
  n / N                next/previous match
  @                    symbols in the current file
  d                    definition near the cursor or by entered name; Esc/Ctrl+C cancels
  F5 / r               revalidate and reload the current file
  p                    export print-ready HTML

Palettes
  Up/Down, Tab         select a result
  PageUp/PageDown      move by page
  Home/End             first/last result
  Enter                search or open
  Ctrl+V               paste
  Esc                  close; also cancels an active repository search

Mouse
  Wheel                move/scroll
  Left click           select lists, tabs, results, code lines, or footer actions
  Click selected item  open/activate it
  Shift+click          extend source-line selection
  Right click          Esc equivalent

Global
  F2 / a               GitHub authentication
  ,                    settings
  T                    Dark / Light theme
  c / F8               cache manager
  ? / F1               help
  q / Ctrl+Q           quit
```

--------------------------------

### Release Binary Artifacts

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

List of binary archives generated by the release workflow.

```text
repotrek-linux-x86_64.tar.gz
repotrek-linux-aarch64.tar.gz
repotrek-macos-aarch64.tar.gz
repotrek-macos-x86_64.tar.gz
repotrek-windows-x86_64.zip
repotrek-windows-aarch64.zip
SHA256SUMS
```

--------------------------------

### Credential Search Order

Source: https://github.com/yuna-r/repotrek/blob/main/README.md

The order in which RepoTrek checks for authentication credentials.

```text
REPOTREK_GITHUB_TOKEN
GH_TOKEN
GITHUB_TOKEN
GitHub CLI credentials
OS credential store fallback
anonymous access
```
Tokens:
Raw