mcpField
W
wish-ssh-code-review

wish-ssh-code-review

github.com/existential-birdsTesting & quality85114 installsUpdated 11w ago
Repository

About wish-ssh-code-review

wish-ssh-code-review is a review skill for Go applications built with Wish, an SSH server framework. It guides evidence-based checks of server setup, middleware, session handling, and terminal UI configuration.

Key features

  1. 01Ordered review gates
  2. 02Wish server entry-point checks
  3. 03Host-key and middleware review
  4. 04Session and PTY handling checks
  5. 05Finding format with source locations

Use cases

  1. 01Reviewing Wish server initialization
  2. 02Checking middleware order and host-key setup
  3. 03Assessing session state and graceful shutdown
  4. 04Inspecting PTY sizing in terminal interfaces

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/existential-birds/beagle --skill wish-ssh-code-review

After installing, type/wish-ssh-code-reviewin Claude Code to confirm it loaded.

Bundled filesreferences/server.mdreferences/sessions.md

Details

From the project README

Wish SSH Code Review

Quick Reference

Issue TypeReference
Server setup, middlewarereferences/server.md
Session handling, securityreferences/sessions.md

Review gates

Run these in order when producing a written review. Do not claim a defect in a later step until the Pass when for the current step is satisfied for the code under review.

  1. Locate Wish entry points — Pass when: you have at least one repo path per server surface that calls wish.NewServer, wish.WithMiddleware, registers bubbletea.Middleware, or defines the top-level ssh.Handler chain (list the paths explicitly).
  2. Capture server-setup evidence — Pass when: for each path from step 1, you have the actual wish.WithHostKey* / host-key configuration and the full middleware list in source order as written (not recalled from memory). If graceful shutdown exists, note the file(s) where ListenAndServe and Shutdown run.
  3. Capture session / TUI evidence — Pass when: for each teaHandler (or equivalent), you have noted from source whether s.Pty() is checked before using window size, and whether per-session renderers (bubbletea.MakeRenderer) are used where Lipgloss styles apply.
  4. Write findings — Pass when: each finding uses [FILE:LINE] ISSUE_TITLE (line range allowed where needed) and points to the relevant row in Quick Reference (or the matching section in references/).

Review Checklist

Use alongside Review gates; for a written review, complete the gates first so each item below can be tied to cited source.

  • Host keys are loaded from file or generated securely
  • Middleware order is correct (logging first, auth early)
  • Session context is used for per-connection state
  • Graceful shutdown handles active sessions
  • PTY requests are handled for terminal apps
  • Connection limits prevent resource exhaustion
  • Timeout middleware prevents hung connections
  • BubbleTea middleware correctly configured

Critical Patterns

Server Setup
// GOOD - complete server setup
s, err := wish.NewServer(
    wish.WithAddress(fmt.Sprintf("%s:%d", host, port)),
    wish.WithHostKeyPath(".ssh/id_ed25519"),
    wish.WithMiddleware(
        logging.Middleware(),       // first: log all connections
        activeterm.Middleware(),    // handle terminal sizing
        bubbletea.Middleware(teaHandler),
    ),
)
if err != nil {
    return fmt.Errorf("creating server: %w", err)
}
Graceful Shutdown
// BAD - abrupt shutdown
log.Fatal(s.ListenAndServe())

// GOOD - graceful shutdown
done := make(chan os.Signal, 1)
signal.Notify(done, os.Interrupt, syscall.SIGTERM)

go func() {
    if err := s.ListenAndServe(); err != nil && !errors.Is(err, ssh.ErrServerClosed) {
        log.Error("server error", "error", err)
    }
}()

<-done
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
if err := s.Shutdown(ctx); err != nil {
    log.Error("shutdown error", "error", err)
}
BubbleTea Handler
func teaHandler(s ssh.Session) (tea.Model, []tea.ProgramOption) {
    pty, _, _ := s.Pty()

    model := NewModel(pty.Window.Width, pty.Window.Height)

    return model, []tea.ProgramOption{
        tea.WithAltScreen(),
        tea.WithMouseCellMotion(),
    }
}

When to Load References

  • Reviewing server initialization → server.md
  • Reviewing authentication, session state → sessions.md

Review Questions

  1. Are host keys handled securely?
  2. Is middleware order correct?
  3. Is graceful shutdown implemented?
  4. Are PTY window sizes passed to the TUI?
  5. Are connection timeouts configured?

Comments

Markdown supported