Skip to content

feat!: new CLI structure#58

Merged
cmorten merged 29 commits into
mainfrom
feat-cli-refactor
Jul 19, 2026
Merged

feat!: new CLI structure#58
cmorten merged 29 commits into
mainfrom
feat-cli-refactor

Conversation

@cmorten

@cmorten cmorten commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Issue

Fixes #56, #57

Details

Breaking changes

The CLI has been restructured to separate environment configuration from screen reader asset installation.

The previous setup flow has been split into two commands:

  • setup – configures the host environment, should be run once per machine.
  • install – downloads and installs screen reader assets, should be run once per project and after every update to @guidepup/guidepup

Usage:

# Setup machine once for screen reader automation
npx @guidepup/setup setup

# In project directory install Guidepup
npm install @guidepup/guidepup

# In project directory install required screen reader assets
npx @guidepup/setup install

setup changes

Windows

  • setup is now a no-op.
  • It no longer disables the foreground lock timeout or installs NVDA.

macOS

  • Existing setup behaviour is unchanged.
  • The following flags have been renamed:
    • --record--macos-record
    • --ignore-tcc-db--macos-ignore-tcc-db

New install command

The new install command downloads and installs screen reader assets:

  • Windows: installs NVDA assets from guidepup/nvda.
  • macOS: installs VoiceOver assets from guidepup/voiceover.

Asset storage

Downloaded assets are now stored in the operating system’s cache directory.

Previously, on Windows, assets were downloaded to a temporary directory.

CheckList

  • Has been tested (where required).

Comment thread package.json Outdated
Comment thread .github/workflows/test.yml Fixed
@cmorten
cmorten merged commit 4510de5 into main Jul 19, 2026
22 checks passed
@cmorten
cmorten deleted the feat-cli-refactor branch July 19, 2026 13:14
@cmorten cmorten changed the title feat: new CLI structure feat!: new CLI structure Jul 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Redesign @guidepup/setup CLI to support subcommands and future extensibility

2 participants