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 and opens the browser automatically. Use --port 9000 to change the port. 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

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.0.tar.gz (24.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.0-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pipkinpad-0.1.0.tar.gz
  • Upload date:
  • Size: 24.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.0.tar.gz
Algorithm Hash digest
SHA256 8243796e85682e7bad8fd1adac7c9d19f0ee440ff5a3d6c828a43fe4df2b1828
MD5 df1d3fab5e5f99f3fe48da88ce61196a
BLAKE2b-256 2c3c1f3c29275c571e108706690aa00113951b8144b36b492eca651f7602d611

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipkinpad-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: pipkinpad-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 27.2 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d3c86239efc2e871b749d3839eb12b6dd765954a69afadeea15226d1b8b0ba6
MD5 c6ac7eb08abdb73f14575c82412d641e
BLAKE2b-256 85458d10caa10c1f6687a9fe6b0d3595363d72836b768dbf477aad3c777dee6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipkinpad-0.1.0-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