Skip to main content

PipkinPad: a local, AI-assisted file manager and terminal workspace.

Project description

PipkinPad

PipkinPad is a locally-run Python workbench: manage files in the current directory, use a persistent terminal, and let an OpenAI API-compatible AI assist with processing work tasks.

Installation & Startup

pip install pipkinpad
cd your-project
pipkinpad start

The app listens on 127.0.0.1:8765 by default. Use --port 9000 to change the port. By default the browser is not opened automatically; add --browser to open it on start. The startup directory is the workspace root — the service and AI cannot access paths outside it.

To use the same workbench from another device on a trusted network, start it on the host machine with:

pipkinpad start --host 0.0.0.0

Then visit http://HOST_IP:8765 from the other device. Do not expose this service to an untrusted network or the public internet.

Configure the model (keys are never echoed):

pipkinpad config --base-url https://api.openai.com/v1 --model gpt-4.1-mini --api-key YOUR_KEY
pipkinpad config
pipkinpad clear-config

Password protection

Set a password before starting the server to require login in the browser:

pipkinpad config --password YOUR_PASSWORD

After a successful login, PipkinPad remembers that browser for 30 days using an HTTP-only signed cookie. Changing the password invalidates previous logins. To return to password-free local access:

pipkinpad config --clear-password

The password is never stored directly. Its salted PBKDF2 hash and the cookie signing secret are kept inside PipkinPad's encrypted local settings file.

You can also fill in the "Configure API" panel on the app's right sidebar. Connection parameters and API keys are encrypted and saved to a local config file; the master encryption key is stored in the operating system credential store.

Security Model

  • A random local session token is generated on every startup; the file API and terminal WebSocket require this token.
  • File operations are path-normalized and restricted to the startup directory; hidden files are not shown in the tree.
  • The AI only sees chat history and files or terminal output you explicitly attach.
  • The AI can only propose commands. The page provides a confirmation button for each Bash command; once confirmed, the command runs in the workspace's isolated Bash process, and output is handed back to the AI for further processing. The AI never writes to the human-facing Terminal; when leveraging Terminal context, it can only read its output.
  • UI state is saved in .pipkinpad-ui-state.json in the workspace, so devices connected to the same PipkinPad service share layout, tabs, context settings, and a Terminal-output snapshot.
  • Audit events are saved to .pipkinpad-audit.jsonl in the workspace; API keys and terminal input are never logged.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipkinpad-0.1.4.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipkinpad-0.1.4-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

Details for the file pipkinpad-0.1.4.tar.gz.

File metadata

  • Download URL: pipkinpad-0.1.4.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pipkinpad-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f73374a13251f4740c0b7859e3bdf7e43ff011d2fb4aeb3bd60eae943146e9cd
MD5 5bd30d9e0318e234e07982c2023796d2
BLAKE2b-256 dade88925cfc4839f736ef4f53e675ce3dac9de5963c5debb0626a0632bd9297

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipkinpad-0.1.4.tar.gz:

Publisher: publish.yml on hzq1995/pipkinpad

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pipkinpad-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: pipkinpad-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 36.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pipkinpad-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 92dcdaa2c12990aa6cf147b0395dd7aaab07a3e150d57a5e118fe66bf8099ef9
MD5 69136bbad231cc6e1e8e0f23211d93b9
BLAKE2b-256 64d3d726647ecfdf53d2b20e4647883b3ce3debea3c67ebbb2ff2dc6753431ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipkinpad-0.1.4-py3-none-any.whl:

Publisher: publish.yml on hzq1995/pipkinpad

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page