Skip to main content

A collection of developer tools including markdown rendering, project exporters, agent templates, and cheatsheets management.

Project description

Super Pocket

What's in the pocket ?

  • Readme Generator: Analyze your project (FastAPI project, CLI Tool, Python Package) and generate the best README.md possible for the purpose.

  • Codebase to Markdown: Scan the codebase of your project and generate a unique Markdown file containing all the project files with project tree. Perfect to share with LLMs.

  • XML Tags easy: Using a custom syntax on format tag:<content>, it produces the XML tags -> <tag>content</tag>. Also LLM's friendly.

  • Agent Templates: Manage and distribute AI agent configuration templates such as AGENTS.md.

  • Cheatsheets: Quick access to development cheatsheets

  • Dependencies Scanner: Scan a requirements.txt or pyproject.toml and gives you the outdated packages in a well-printed list (with colors !)

Install it fast

  • With Homebrew (macOS/Linux):

    brew tap dim-gggl/brew && brew install super-pocket
    
  • With uv (recommended):

    uv tool install super-pocket
    
  • With pip/pipx: It is Highly recommended to use a virtual environment.

    python3 -m venv venv
    source venv/bin/activate
    
    pip install super-pocket
    # or
    pipx install super-pocket
    
  • Quick check: pocket --version should answer without whining.

  • Double check: which pocket, in this case should return your/project/path/venv/bin/pocket

Quick usage

Interactive mode (the easy way)

Don't know where to start? Just type:

pocket

This launches a guided interactive menu. Navigate through tools, get prompted for parameters, and explore features without memorizing commands. Type exit or Q to quit.

Direct commands

  • Terminal power-users: pocket --help for the menu, then pocket <group> --help to zoom in.
  • Concrete examples below (all available stand-alone).

Craft a README without sweating

  • pocket project readme -p . scans the repo, asks a few questions, and spits out a full README.
  • Expected output: a push-ready README.md with sections and badges aligned to your stack.

Dump the whole codebase into one Markdown

  • pocket project to-file -p . -o project-all-in-one.md
  • Output: one file with the tree + every file inline. Perfect to drop into an LLM.

Render Markdown nicely in the terminal

  • pocket markdown render README.md -w 100
  • Output: your Markdown with colors and aligned titles directly in the terminal.

Spot the dusty dependencies

  • pocket project req-to-date requirements.txt
  • Typical output: fastapi 0.110.0 -> 0.121.3 (red for the old, green for the new).

Agent templates and cheatsheets

  • List: pocket documents list
  • Copy a template: pocket documents copy unit_tests_agent -o .AGENTS/
  • Initialize everything at once: pocket documents init -o .AGENTS

Convert a file to PDF

  • pocket pdf convert README.md -o README.pdf
  • Output: a clean PDF without fighting LaTeX.

Web goodies

  • Favicons: pocket web favicon logo.png -o favicon.ico --sizes "64x64,32x32"
  • Job search: pocket web job-search "python developer" --work_from_home -o jobs.json (set RAPIDAPI_API_KEY in your env).

Generate LLM-friendly XML

  • pocket xml "note:<hello world>"
  • Output: <note>hello world</note> (chain multiple tags, it keeps up).

Quick cheatsheets

  • View in 2s: pocket documents view SQL -t cheatsheet
  • Local copy to work offline: pocket documents copy git -o docs/cheats/

Stand-alone mode (scripts)

Everything above works directly from the CLI without the interactive UI. Perfect for CI or your own automation scripts.

The initial command pocket is a way to unify all these tools, but it also works to do: req-to-date requirements.txt proj2md -p . -o proj2md.md xml "context:<Job interview post:<back-end developer>>"

This last command should return: Job interview back-end developer

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

super_pocket-1.0.3.tar.gz (70.4 kB view details)

Uploaded Source

Built Distribution

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

super_pocket-1.0.3-py3-none-any.whl (97.2 kB view details)

Uploaded Python 3

File details

Details for the file super_pocket-1.0.3.tar.gz.

File metadata

  • Download URL: super_pocket-1.0.3.tar.gz
  • Upload date:
  • Size: 70.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for super_pocket-1.0.3.tar.gz
Algorithm Hash digest
SHA256 e658144e7783c1dc1c8c40de8181aaa6071dfef2d13b0f65e02818ac77b3d93b
MD5 167c8b4baaf31b5271323a2dfe5a310b
BLAKE2b-256 63620d7716a05686d68aa19fc715d8be3fad1ec4e8a7dcdd88a6360e905ebd94

See more details on using hashes here.

File details

Details for the file super_pocket-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: super_pocket-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for super_pocket-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4b29c1ece900906dbb481f512431c787ca704bd3d382b786af5c088e6d2b6e4d
MD5 36d4b0ea4714cccd3aa4b048def79bb0
BLAKE2b-256 aedd649b8cc12ba4e6826d5519ada96113c7f6a480b66fc1b15715c8b1fa85d1

See more details on using hashes here.

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