Skip to content

docs: link docs/ from README and fix stale command name #1220

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

Merged
John-David Dalton (jdalton) merged 1 commit into from
Apr 17, 2026
Merged

docs: link docs/ from README and fix stale command name #1220

Show file tree
Hide file tree
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,14 @@ Key variables for development:
| `SOCKET_CLI_API_BASE_URL` | Override API endpoint |
| `SOCKET_CLI_NO_API_TOKEN` | Disable default API token |

## Further Reading

- [`docs/build-guide.md`](docs/build-guide.md) — build pipeline, SEA binaries, cache management
- [`docs/bundle-tools.md`](docs/bundle-tools.md) — how bundled tools (opengrep, trivy, etc.) are integrated
- [`packages/cli/README.md`](packages/cli/README.md) — CLI package architecture
- [`packages/build-infra/README.md`](packages/build-infra/README.md) — shared build tooling
- [`packages/package-builder/README.md`](packages/package-builder/README.md) — template-based package generation

## See Also

- [Socket API Reference](https://docs.socket.dev/reference)
Expand Down
4 changes: 2 additions & 2 deletions docs/build-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,13 +252,13 @@ Assets are downloaded from [socket-btm](https://github.com/SocketDev/socket-btm)

```bash
# Clear download cache
pnpm run clean-cache
pnpm run clean:cache

# Clear CLI build cache
pnpm --filter @socketsecurity/cli run clean

# Clear all caches
pnpm clean
pnpm run clean
```

### Environment Variables
Expand Down