pi-cwd-guard

Small Pi safety extension for cwd access, protected paths, runtime config confirmation, and common destructive bash commands.

Packages

Package details

extension

Install pi-cwd-guard from npm and Pi will load the resources declared by the package manifest.

$ pi install npm:pi-cwd-guard
Package
pi-cwd-guard
Version
0.3.3
Published
May 28, 2026
Downloads
541/mo · 541/wk
Author
devnazim
License
MIT
Types
extension
Size
29 KB
Dependencies
0 dependencies · 1 peer
Pi manifest JSON
{
  "extensions": [
    "./src/index.ts"
  ]
}

Security note

Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.

README

pi-cwd-guard

A small Pi safety extension package for cwd access, protected paths, runtime config confirmation, and common destructive bash commands.

What it guards

The extension intercepts these built-in tools:

  • read
  • write
  • edit
  • bash

Current working directory guard

Before read, write, or edit runs, the extension strips a leading @ the same way Pi's built-in file tools do, then resolves the tool's path argument against the current working directory.

  • If the resolved path is inside the current working directory, the tool continues to the next checks.
  • If the resolved path is outside the current working directory and is not covered by allowedOutsideCwdPaths, Pi asks for confirmation.
  • If no UI is available, outside-cwd access is blocked by default unless the path is covered by allowedOutsideCwdPaths.

Configuring outside-cwd exceptions

You can allow specific outside-cwd paths with JSON config files:

  • Project-local: .pi/pi-cwd-guard.json
  • Global: ~/.pi/agent/extensions/pi-cwd-guard.json

Example:

{
  "allowedOutsideCwdPaths": [
    "/tmp",
    "/var/tmp",
    "~/shared-workspace",
    "../sibling-project"
  ]
}

Notes:

  • Multiple paths are supported.
  • Matching is recursive: allowing /tmp allows /tmp/foo/bar.txt.
  • ~ expands to your home directory.
  • Absolute paths are used as-is.
  • Relative paths in project config resolve against the current working directory.
  • Relative paths in global config resolve against ~/.pi/agent/extensions.
  • Project and global allowedOutsideCwdPaths are merged.
  • These exceptions only skip the outside-cwd confirmation. They do not bypass hard-protected path blocks, runtime config confirmation, or destructive bash confirmation.

You can also inspect or update the config from Pi with the /cwd-guard command:

/cwd-guard
/cwd-guard show
/cwd-guard allow /tmp --project
/cwd-guard allow /tmp --global
/cwd-guard allow /tmp /var/tmp ~/shared-workspace --project
/cwd-guard allow "/tmp/my folder" --project

Command notes:

  • /cwd-guard opens an interactive menu for showing config or adding exceptions. Without UI, it displays the merged active configuration.
  • /cwd-guard show displays the merged active configuration.
  • Typing /cwd-guard in interactive mode autocompletes subcommands, and allow ... autocompletes --project / --global.
  • allow <path...> --project updates .pi/pi-cwd-guard.json.
  • allow <path...> --global updates ~/.pi/agent/extensions/pi-cwd-guard.json and asks for confirmation first.
  • Paths added by the command are written as absolute resolved paths.
  • Command arguments support shell-style single quotes, double quotes, and backslash escapes for paths with spaces.

Hard-protected paths

write and edit are blocked for sensitive, vendor, or generated paths such as:

  • .env, .env.*
  • secrets/, .secrets/, credentials/, .credentials/
  • .npmrc, .pypirc, id_rsa, id_ed25519, kubeconfig files
  • common credential JSON files such as secrets.json, credentials.json, client_secret.json, service-account JSON files
  • *.pem, *.key, *.p12, *.pfx
  • node_modules/
  • generated/build output dirs like dist/, build/, coverage/, .next/, .nuxt/, generated/

These are hard-blocked rather than confirmed.

Runtime config confirmation

write and edit ask for confirmation before changing likely runtime config, including paths like env.ts, runtime-config.ts, app-config.ts, config.ts, config.json, appsettings.json, application.yml, deployment config such as docker-compose.yml, serverless.yml, vercel.json, netlify.toml, wrangler.toml, and config files under config-ish/deployment directories such as config/*.ts, config/*.json, k8s/*.yaml, or infra/*.tfvars. For config-ish files/directories only, edits containing obvious environment/API markers also ask for confirmation, such as:

  • BASE_URL
  • API_URL
  • PUBLIC_*
  • *_KEY
  • *_TOKEN
  • CLIENT_ID
  • CLIENT_SECRET
  • process.env
  • znv

If no UI is available, runtime config changes are blocked by default.

Permission prompt notifications

If pi-cmux is installed, pi-cwd-guard sends a best-effort cmux notification/status update whenever it opens a permission confirmation. This is optional and no-ops when pi-cmux is not present.

Common destructive bash confirmation

bash asks for confirmation before common destructive commands such as:

  • recursive/forced rm
  • sudo
  • dangerous chmod
  • recursive chown
  • git reset --hard
  • git clean -fd

This is intentionally heuristic and small. It does not parse shell scripts, inspect script files, or sandbox Python/Node.js/other scripts. For scripts, the extension adds advisory prompt guidance telling the agent to ask before intentionally accessing paths outside process.cwd() unless the path is covered by configured allowedOutsideCwdPaths.

Install

From npm:

pi install npm:pi-cwd-guard

From a local checkout:

pi install /absolute/path/to/pi-cwd-guard

Or test for one run:

pi -e /absolute/path/to/pi-cwd-guard

The package also includes a root index.ts shim, so direct extension-directory configuration such as "extensions": ["/absolute/path/to/pi-cwd-guard"] works too.

Development

npm install
npm run typecheck
npm run pack:dry-run

Package manifest

This package exposes its extension through:

{
  "pi": {
    "extensions": ["./src/index.ts"]
  }
}