sideye 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +60 -46
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,27 +1,39 @@
1
1
  # sideye
2
2
 
3
- Keep a skeptical side-eye on your CLI coding agents. Run claude code, opencode, or codex in one terminal pane
4
- and `sideye` in the next — and stop opening an editor just to see **what is there, what is
5
- happening, and what is the difference**.
6
-
7
- Everything an IDE shows you, nothing it does for you. The "integrated" part is deliberately
8
- missing: your agent, your editor, and `sideye` stay decoupled. It never reviews, explains,
9
- approves, or talks back to an agent — you render judgment on the robot's output, then paste a
10
- `path:line` reference back into the agent conversation to redirect it in your own words.
11
-
12
- ## Pillars
13
-
14
- - **The whole repo, with changes overlaid.** The full project tree renders like an IDE sidebar
15
- (gitignore respected), changed files tinted and tagged, unchanged files quietly browsable.
16
- Open any file read-only with syntax highlighting; open a changed file as a diff.
17
- - **Simple change scopes.** Cycle between all changes, staged only, and unstaged only with one
18
- key — no restart, no flags to remember.
19
- - **Live, with activity awareness.** The view polls git while the agent works. Recently touched
20
- files get a recency dot that decays, the status bar shows the last activity, and one key jumps
21
- to whatever the agent just edited.
22
- - **Static analysis where an IDE would put it.** lint, tsc, and prettier findings show up as a
23
- problems panel, inline line markers in the viewer, and per-file markers in the tree — anywhere
24
- in the repo, not just changed files. Checks re-run automatically once the repo goes quiet.
3
+ `sideye` is a read-only terminal UI for watching a repo while a CLI coding agent
4
+ changes it.
5
+
6
+ The usual workflow is awkward. The agent is in one terminal pane, but you still
7
+ open an editor just to answer basic questions:
8
+
9
+ - What files are in this repo?
10
+ - What changed?
11
+ - What did the agent touch most recently?
12
+ - Did lint, typecheck, or formatting break?
13
+
14
+ `sideye` is meant to sit in the next pane and answer those questions without
15
+ becoming part of the agent loop. It does not review code, approve changes, talk
16
+ to the agent, or manage a workflow. It shows you the repo, the diff, and the
17
+ problems. You decide what to say next.
18
+
19
+ ## What it does
20
+
21
+ - Shows the full repo tree, including tracked files and untracked files that are
22
+ not ignored by git.
23
+ - Marks changed files in place, with staged, unstaged, mixed, and untracked
24
+ states.
25
+ - Opens unchanged files read-only, with syntax highlighting.
26
+ - Opens changed files as diffs, with a toggle for the full file.
27
+ - Switches between all changes, staged changes, and unstaged changes.
28
+ - Polls git while the agent works, then keeps the current file and selection
29
+ stable as the view refreshes.
30
+ - Marks recent activity and lets you jump to the latest touched file.
31
+ - Shows diagnostics in the tree, in the viewer, and in a problems panel.
32
+ - Copies a `path:line` reference and snippet so you can paste it back into the
33
+ agent conversation.
34
+
35
+ The git-backed file tree renders first. Diagnostics come in later as decorations.
36
+ That keeps the basic view useful even when checks are still running.
25
37
 
26
38
  ## Install
27
39
 
@@ -29,14 +41,14 @@ approves, or talks back to an agent — you render judgment on the robot's outpu
29
41
  # standalone binary (macOS / Linux, no runtime needed)
30
42
  curl -fsSL https://raw.githubusercontent.com/jimmy-guzman/sideye/main/install.sh | bash
31
43
 
32
- # npm (works with npm, bun, pnpm, yarn — pulls a prebuilt binary)
44
+ # npm (works with npm, bun, pnpm, yarn; pulls a prebuilt binary)
33
45
  npm i -g sideye
34
46
 
35
47
  # homebrew
36
48
  brew install jimmy-guzman/tap/sideye
37
49
  ```
38
50
 
39
- ## Use it
51
+ ## Usage
40
52
 
41
53
  ```sh
42
54
  sideye # whole repo, worktree vs HEAD
@@ -47,25 +59,25 @@ sideye --unstaged # start in the unstaged scope
47
59
 
48
60
  ## Keys
49
61
 
50
- | Key | Action |
51
- | ----------- | ----------------------------------------------- |
52
- | `j` / `k` | move in the tree, viewer, or problems panel |
53
- | `h` / `l` | collapse / expand folders |
54
- | `tab` | switch focus between tree and viewer |
55
- | `enter` | open the focused item / jump to a problem |
56
- | `ctrl-p` | go to file: fuzzy-search the whole repo |
57
- | `s` | cycle scope: all changes → staged → unstaged |
58
- | `c` | toggle changes-only filter for the tree |
59
- | `v` | toggle diff ↔ full file view for a changed file |
60
- | `p` | toggle the problems panel |
61
- | `.` | jump to the most recently changed file |
62
- | `n` | jump to the next file with findings |
63
- | `y` | copy `path:line` + snippet at the cursor |
64
- | `f` | load full content when truncated |
65
- | `r` | re-run checks |
66
- | `ctrl-d/u` | half-page cursor movement in the viewer |
67
- | `g` / `G` | jump to first / last line |
68
- | `q` / `esc` | quit (esc closes the problems panel first) |
62
+ | Key | Action |
63
+ | ----------- | ------------------------------------------------- |
64
+ | `j` / `k` | move in the tree, viewer, or problems panel |
65
+ | `h` / `l` | collapse / expand folders |
66
+ | `tab` | switch focus between tree and viewer |
67
+ | `enter` | open the focused item / jump to a problem |
68
+ | `ctrl-p` | go to file: fuzzy-search the whole repo |
69
+ | `s` | cycle scope: all changes -> staged -> unstaged |
70
+ | `c` | toggle changes-only filter for the tree |
71
+ | `v` | toggle diff <-> full file view for a changed file |
72
+ | `p` | toggle the problems panel |
73
+ | `.` | jump to the most recently changed file |
74
+ | `n` | jump to the next file with findings |
75
+ | `y` | copy `path:line` + snippet at the cursor |
76
+ | `f` | load full content when truncated |
77
+ | `r` | re-run checks |
78
+ | `ctrl-d/u` | half-page cursor movement in the viewer |
79
+ | `g` / `G` | jump to first / last line |
80
+ | `q` / `esc` | quit (esc closes the problems panel first) |
69
81
 
70
82
  ## Requirements
71
83
 
@@ -81,7 +93,9 @@ bun run check # tests + typecheck
81
93
  bun run build:dist # build standalone binaries for all targets
82
94
  ```
83
95
 
84
- ## What it will not do
96
+ ## Non-goals
85
97
 
86
- No AI integration, no gating, no accept/reject protocol, no generated review explanations.
87
- The agent never hears from `sideye` — only from you.
98
+ `sideye` is deliberately not an agent integration.
99
+
100
+ No approvals. No accept/reject protocol. No generated review explanation. No PR
101
+ workflow. No database. The agent never hears from `sideye`, only from you.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sideye",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Read-only companion TUI for CLI coding agents",
5
5
  "repository": "github:jimmy-guzman/sideye",
6
6
  "homepage": "https://github.com/jimmy-guzman/sideye",
@@ -18,9 +18,9 @@
18
18
  "sideye": "./bin/sideye.js"
19
19
  },
20
20
  "optionalDependencies": {
21
- "sideye-darwin-arm64": "0.1.3",
22
- "sideye-darwin-x64": "0.1.3",
23
- "sideye-linux-x64": "0.1.3",
24
- "sideye-linux-arm64": "0.1.3"
21
+ "sideye-darwin-arm64": "0.1.4",
22
+ "sideye-darwin-x64": "0.1.4",
23
+ "sideye-linux-x64": "0.1.4",
24
+ "sideye-linux-arm64": "0.1.4"
25
25
  }
26
26
  }