valknar/llmx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README to use pnpm commands (#390)

Browse Source 
Since we migrated to `pnpm` in #287, this updates the README to reflect
that change.
Just a small cleanup to align the commands with the current setup.
This commit is contained in:
Benny Yen
2025-04-19 13:16:13 +08:00
committed by GitHub
parent 1a8610cd9e
commit fd6f6c51c0
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -244,6 +244,8 @@ npm install -g @openai/codex
yarn global add @openai/codex yarn global add @openai/codex
# or # or
bun install -g @openai/codex bun install -g @openai/codex
# or
pnpm add -g @openai/codex
``` ```
</details> </details>
@@ -256,9 +258,12 @@ bun install -g @openai/codex
git clone https://github.com/openai/codex.git git clone https://github.com/openai/codex.git
cd codex/codex-cli cd codex/codex-cli
# Enable corepack
corepack enable
# Install dependencies and build # Install dependencies and build
npm install pnpm install
npm run build pnpm build
# Get the usage and the options # Get the usage and the options
node ./dist/cli.js --help node ./dist/cli.js --help
@@ -267,7 +272,7 @@ node ./dist/cli.js --help
node ./dist/cli.js node ./dist/cli.js
# Or link the command globally for convenience # Or link the command globally for convenience
npm link pnpm link
``` ```
</details> </details>
@@ -376,7 +381,7 @@ More broadly we welcome contributions – whether you are opening your very firs
- Create a _topic branch_ from `main` – e.g. `feat/interactive-prompt`. - Create a _topic branch_ from `main` – e.g. `feat/interactive-prompt`.
- Keep your changes focused. Multiple unrelated fixes should be opened as separate PRs. - Keep your changes focused. Multiple unrelated fixes should be opened as separate PRs.
- Use `npm run test:watch` during development for super‑fast feedback. - Use `pnpm test:watch` during development for super‑fast feedback.
- We use **Vitest** for unit tests, **ESLint** + **Prettier** for style, and **TypeScript** for type‑checking. - We use **Vitest** for unit tests, **ESLint** + **Prettier** for style, and **TypeScript** for type‑checking.
- Before pushing, run the full test/type/lint suite: - Before pushing, run the full test/type/lint suite:
@@ -403,14 +408,14 @@ npm test && npm run lint && npm run typecheck
```bash ```bash
# Watch mode (tests rerun on change) # Watch mode (tests rerun on change)
npm run test:watch pnpm test:watch
# Type‑check without emitting files # Type‑check without emitting files
npm run typecheck pnpm typecheck
# Automatically fix lint + prettier issues # Automatically fix lint + prettier issues
npm run lint:fix pnpm lint:fix
npm run format:fix pnpm format:fix
``` ```
#### Nix Flake Development #### Nix Flake Development
@@ -500,13 +505,13 @@ To publish a new version of the CLI, run the release scripts defined in `codex-c
1. Open the `codex-cli` directory 1. Open the `codex-cli` directory
2. Make sure you're on a branch like `git checkout -b bump-version` 2. Make sure you're on a branch like `git checkout -b bump-version`
3. Bump the version and `CLI_VERSION` to current datetime: `npm run release:version` 3. Bump the version and `CLI_VERSION` to current datetime: `pnpm release:version`
4. Commit the version bump (with DCO sign-off): 4. Commit the version bump (with DCO sign-off):
```bash ```bash
git add codex-cli/src/utils/session.ts codex-cli/package.json git add codex-cli/src/utils/session.ts codex-cli/package.json
git commit -s -m "chore(release): codex-cli v$(node -p \"require('./codex-cli/package.json').version\")" git commit -s -m "chore(release): codex-cli v$(node -p \"require('./codex-cli/package.json').version\")"
``` ```
5. Copy README, build, and publish to npm: `npm run release` 5. Copy README, build, and publish to npm: `pnpm release`
6. Push to branch: `git push origin HEAD` 6. Push to branch: `git push origin HEAD`
--- ---