Skip to main content

vimgarden

Release PyPI Python CI License: GPL-3.0 Dependencies

Cultivate ancient bonsai trees in your terminal. Modal Vim controls, real-time seasons, organic ASCII art, and zero external dependencies.

vimgarden demo

Comparison with cbonsai

While cbonsai is a fantastic procedural screensaver that generates a tree in ~2 seconds, vimgarden is a persistent Zen simulation and bonsai caretaking game:

Feature cbonsai vimgarden
Category Static screensaver / generator Persistent Zen garden simulation game
Lifecycle Generates in ~2s, vanishes on exit Real-time growth, tree aging (minutes to years), offline catch-up
Care & Mechanics Passive display Water, fertilize, prune, wire-shape, shop economy
Multi-Tree 1 tree per invocation Tokonoma shelf holding 3–5 living bonsai pots
Bonsai Styling Random branching Manual branch training (Chokkan, Moyogi, Kengai) with Copper Wire
Controls CLI flags Full Vim modal navigation (h/l, w, x, :wq)
Persistence None Atomic JSON saves with automatic backup and crash recovery
Dependencies C (ncurses) Pure Python standard library (curses)

Features

  • Tokonoma Shelf: Cultivate a collection of 3 to 5 bonsai trees simultaneously, navigating with h/l or 1-5.
  • Dynamic Seasons & Weather: Experience Spring 🌸, Summer ☀️, Autumn 🍁, and Winter ❄️ with rain auto-watering and seasonal growth synergies.
  • Tree Age & Bonsai Styling: Trees age in real-world time (h, d, mo, y), gaining value. Shape branches using Copper Wire (c) into Formal (Chokkan), Informal (Moyogi), or Cascade (Kengai) styles.
  • Organic ASCII Art: Detailed layered canopies (Dan-zukuri), driftwood trunks, drifting sakura petals, and ceramic pot pottery.
  • Vim Modal Navigation:
    • NORMAL: h/l pot select, w water, f fertilize, c wire/style, x prune/harvest, p plant, s shop, i inventory, ? guide.
    • COMMAND: :w save, :q quit, :wq / :x save & quit, :q! force quit.
  • Zero Dependencies: Pure Python standard library (curses). No pip packages required.
  • Safe Persistence: Atomic JSON saves with automatic backup copy and corruption recovery.

Requirements

  • Python >= 3.10
  • Terminal window of at least 80x24 characters

Installation

pipx install vimgarden

Or with pip:

pip install --user vimgarden

From Source

git clone https://github.com/ShwoubleTrouble/vimgarden.git
cd vimgarden

# Lightweight install to ~/.local/bin/ (no pip/venv overhead):
./install.sh

# Or uninstall:
./install.sh --uninstall

Running

# Via console script:
vimgarden

# Or directly as module:
python3 -m vimgarden

Running Tests

python3 -m unittest discover tests

License

GPL-3.0

Metadata

Release files for vimgarden 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vimgarden 0.3.0
File Size Uploaded Provenance
vimgarden-0.3.0.tar.gz 41.9 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for vimgarden 0.3.0
File Interpreter ABI Platform
vimgarden-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 82.1 kB

Release files / vimgarden-0.3.0.tar.gz

Download URL vimgarden-0.3.0.tar.gz
Size 41.9 kB
Tags Source
SHA-256 checksum
How to use checksums
8a827630f6858c25495fc3338e1af20d9dd2854f330ea3dfc95695c46479b073
BLAKE2b-256 checksum
How to use checksums
5064c63fe70eece1d18fb2c9630fec4f495dc3089aec2b2d040f700993d87b84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.

Transparency log

Release files / vimgarden-0.3.0-py3-none-any.whl

Download URL vimgarden-0.3.0-py3-none-any.whl
Size 40.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a6efca161c31bb20bda918a2cccca8b062f11a0d7c5c2a70967d3e40d1d428e9
BLAKE2b-256 checksum
How to use checksums
48ba1e5d21c57d29437201c8f19e6ab87f86b76f619b04254270456a31b2effd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.

Transparency log

Security for vimgarden 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vimgarden-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page