Skip to content

docs: fix stale facts in CLAUDE.md files #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smini-digital wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix stale facts in CLAUDE.md files #144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ This file provides guidance to Claude Code when working with this repository.
`llm-cli-setup` serves two purposes:

1. **Standalone CLI** (`npm start` / `llm-cli-setup`) - interactive menu for developers to install and configure CLI tools
2. **Library** (`import from 'llm-cli-setup'`) - consumed by `environment-setup` to provide CLI tool setup as part of the broader dev environment onboarding
2. **Library** (`import from '@enthus-appdev/llm-cli-setup'`) - consumed by `environment-setup` to provide CLI tool setup as part of the broader dev environment onboarding

## CRITICAL: Two Entry Points
## Two Entry Points

This project has **two separate entry points** that BOTH need updating when adding features:
This project has **two separate entry points** that both need updating when adding features:

| File | Purpose | Who uses it |
|------|---------|-------------|
| `bin/cli.js` | Standalone CLI menu, `--flags`, step counter | Developers running `npm start` or `llm-cli-setup` directly |
| `lib/index.js` | Library exports, `configureShellEnv()`, `CLI_TOOLS` array, status display | `environment-setup` via `import { configureShellEnv } from 'llm-cli-setup'` |
| `lib/index.js` | Library exports, `configureShellEnv()`, `CLI_TOOLS` array, status display | `environment-setup` via `import { configureShellEnv } from '@enthus-appdev/llm-cli-setup'` |

**`lib/index.js` contains `configureShellEnv()`** which is what environment-setup calls. This function has its own `CLI_TOOLS` array with status checks, configure functions, and the tool selection menu. This is SEPARATE from `bin/cli.js`.

Expand All @@ -25,7 +25,7 @@ This project has **two separate entry points** that BOTH need updating when addi
```bash
npm install # Install dependencies
npm start # Run the standalone CLI
npm link # Link globally for testing (use in environment-setup: npm link llm-cli-setup)
npm link # Link globally for testing (use in environment-setup: npm link @enthus-appdev/llm-cli-setup)
```

## Architecture
Expand All @@ -45,7 +45,7 @@ npm link # Link globally for testing (use in environment-setup: npm link
### Installers (`lib/installers/`)

Each tool has its own module following the same pattern:
- `findBinary()` - locate installed binary (PATH + common locations)
- `find<Tool>Binary()` - locate installed binary (PATH + common locations)
- `is*Installed()` / `is*Configured()` - status checks
- `install*()` - installation via `go install` or package manager
- `configure*()` - interactive setup flow (install prompt, config, status display)
Expand All @@ -65,7 +65,7 @@ Current tools: `sqlcmd.js`, `gh.js`, `atl.js`, `n8n.js`, `gcx.js`, `m365.js`, `e

## Adding a New CLI Tool

**You must update ALL of these files:**
Update all of these files:

1. **`lib/installers/<tool>.js`** - Create installer module (copy `n8n.js` or `esq.js` as template)
2. **`lib/installers/index.js`** - Add exports
Expand Down
Loading