diff --git a/CLAUDE.md b/CLAUDE.md index b83fd0dfa6..09a8499345 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,18 +4,14 @@ This is the Bun repository - an all-in-one JavaScript runtime & toolkit designed ### Build Commands -- **Build debug version**: `bun bd` +- **Build Bun**: `bun bd` - Creates a debug build at `./build/debug/bun-debug` - - **CRITICAL**: DO NOT set a build timeout. Compilation takes ~5 minutes. Be patient. + - **CRITICAL**: no need for a timeout, the build is really fast! - **Run tests with your debug build**: `bun bd test ` - **CRITICAL**: Never use `bun test` directly - it won't include your changes - **Run any command with debug build**: `bun bd ` -### Other Build Variants - -- `bun run build:release` - Release build - -Address sanitizer is enabled by default in debug builds of Bun. +Tip: Bun is already installed and in $PATH. The `bd` subcommand is a package.json script. ## Testing diff --git a/docs/nav.ts b/docs/nav.ts index 90514e1eca..0e7c91bed0 100644 --- a/docs/nav.ts +++ b/docs/nav.ts @@ -407,6 +407,9 @@ export default { page("api/cc", "C Compiler", { description: `Build & run native C from JavaScript with Bun's native C compiler API`, }), // "`bun:ffi`"), + page("api/secrets", "Secrets", { + description: `Store and retrieve sensitive credentials securely using the operating system's native credential storage APIs.`, + }), // "`Bun.secrets`"), page("cli/test", "Testing", { description: `Bun's built-in test runner is fast and uses Jest-compatible syntax.`, }), // "`bun:test`"),