learningequality / learningequality/ricecooker

`remote/cli.py` — `remote` subcommand group on the chef CLI

Open
#707 0 comments 1 reaction 1 assignee View on GitHub

@rtibblesbot is already working on this.

Since Jul 24, 2026.

TAG: new feature
Dominant language
Python
Stars
31
Forks
77
Avg merge
5d 4h
Merged PRs (30d)
3

Description

This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Overview

A cli.py module registering a remote subcommand group on the existing SushiChef parser, for out-of-band operations. Invoked as python chef.py remote <cmd>. The chef is the script itself, so nothing needs resolving from the working directory.

Complexity: Medium
Target branch: main

Context
  • Hangs off the same parser --remote lives on (chefs.py).
  • Commands: remote {attach,sync,pull,shell,cache,doctor}.
  • Reuses config.py (#703), session.py (#705), and driver.py (#706).
  • pull paths are relative to the remote chef dir.
The Change
  • Add a doctor command reporting which box dependencies are present.
Out of Scope
  • The --remote run path itself (driver.py).
  • A standalone console script or [project.scripts] entry — the chef CLI is the entry point.
Acceptance Criteria
  • python chef.py remote attach attaches to the chef's live session.
  • python chef.py remote sync syncs the working tree to the box without running.
  • python chef.py remote pull <remote-path> [dest] fetches a path relative to the remote chef dir.
  • python chef.py remote shell opens a shell in the chef dir on the box.
  • python chef.py remote cache info reports the shared cache.
  • python chef.py remote cache clear clears the shared cache.
  • python chef.py remote doctor checks ffmpeg, poppler-utils, pandoc, single-file-cli, uv, and tmux.
  • doctor reports which of those are missing.
  • doctor reports when a chef falls back to the shared default venv.
  • doctor installs nothing.
  • Integration tests drive the commands through the fake-box runner.
  • User-facing docs cover config setup (global profiles + per-chef file), the --remote run workflow, and the remote subcommands.
AI usage

Claude (Claude Code) drafted this from the design spec; I directed the design and reviewed it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.