Skip to content

docs(architecture): correct the current CLI source inventory #23

Closed

Description

@showxu

Summary

The current package architecture lists ExperimentalInstallCommand.swift, which does not exist at the inspected revision. It omits the actual InstallCommand.swift and DoctorCommand.swift files from its CLI source inventory.

Code evidence at 5d4987b:

  • Documentation/Architecture/Package.md:49 begins the CLI inventory; :54 names the nonexistent file.
  • Sources/CLI/InstallCommand.swift:1 and Sources/CLI/DoctorCommand.swift:1 are the current source files.
  • Sources/CLI/EntryPoint.swift:39 registers Install and Doctor in the current command surface.

Reproduction

Executed at 5d4987b.

Run in Bash after cd "<checkout>" && swift build, replacing <checkout> with the absolute path of the checkout at this revision. Use a fresh reproduction directory. The commands isolate HOME, agent configuration, and XDG_*, and remove their fixture root on exit.

set -eu
checkout="<checkout>"
skill_bin="$checkout/.build/debug/skill"
repro_root="$checkout/.build/issue-repro-architecture-doc"
mkdir -p "$repro_root/home" "$repro_root/tmp" "$repro_root/project"
trap 'rm -rf "$repro_root"' EXIT
isolated() {
  env -i PATH="$PATH" HOME="$repro_root/home" \
    CODEX_HOME="$repro_root/home/.codex" \
    CLAUDE_CONFIG_DIR="$repro_root/home/.claude" \
    XDG_CONFIG_HOME="$repro_root/home/.config" \
    XDG_STATE_HOME="$repro_root/home/.local/state" \
    XDG_CACHE_HOME="$repro_root/home/.cache" TMPDIR="$repro_root/tmp" \
    GIT_CONFIG_NOSYSTEM=1 GIT_CONFIG_GLOBAL=/dev/null \
    GIT_AUTHOR_NAME=Fixture [email protected] \
    GIT_COMMITTER_NAME=Fixture [email protected] \
    "$@"
}
skill() { isolated "$skill_bin" "$@"; }
cd "$repro_root/project"


cd "$checkout"
isolated rg -n 'ExperimentalInstallCommand' Documentation/Architecture/Package.md
for name in ExperimentalInstallCommand InstallCommand DoctorCommand; do
  if test -f "Sources/CLI/$name.swift"; then
    printf '%s: present\n' "$name"
  else
    printf '%s: absent\n' "$name"
  fi
done

Observed output (relevant lines; temporary paths shortened to <temp>):

54:      ExperimentalInstallCommand.swift
ExperimentalInstallCommand: absent
InstallCommand: present
DoctorCommand: present

Expected Behavior

Update the architecture inventory to describe the current CLI owners accurately. This is a correction to current architecture, not a rewrite of historical decision records.

Completion checks:

  • Every CLI file named in the inventory exists at the documented revision.
  • Install and doctor are represented by their current files.
  • Compare the tree against Sources/CLI; no build or behavior change is required.

Actual Behavior

The documentation's named file is absent; the current install and doctor files are present. The verification commands above were executed.

Duplicate check: no matching open/closed issue or PR. PR #3 concerns GitHub templates/security guidance and does not cover this inventory.

Environment

  • Source revision: 5d4987b (5d4987b9e1f94e8b9f85124299f05d5aa4f45f07).
  • CLI version: 0.2.1; built successfully with swift build.
  • Swift: Apple Swift 6.4 (swiftlang-6.4.0.34.1, clang-2100.3.34.1).
  • OS: macOS 27.0.1 (26A434).
  • Architecture: arm64.
  • Git: 2.42.0. Validation date: 2026-10-17.

Activity

  1. added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    on Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions