docs: update changelog and readme for cd-browser v0.1.1
This commit is contained in:
29
CHANGELOG.md
29
CHANGELOG.md
@@ -4,16 +4,23 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
The format is based on Keep a Changelog, and this project follows Semantic Versioning.
|
The format is based on Keep a Changelog, and this project follows Semantic Versioning.
|
||||||
|
|
||||||
## [1.0.0] - 2026-03-14
|
## [0.1.1] - 2026-03-16
|
||||||
|
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Initial release of the Python AI Dev Template
|
- AI logging system
|
||||||
- Universal Python project structure using `src/`
|
- AI agent workflow framework
|
||||||
- `pyproject.toml`-based project configuration
|
- ai-task tooling
|
||||||
- Development tooling with `black`, `ruff`, `mypy`, and `pytest`
|
|
||||||
- `pre-commit` integration
|
### Improved
|
||||||
- `Makefile` with development, quality, and diagnostic commands
|
- Terminal navigation
|
||||||
- `instructions-agent.md` for AI coding agent guidance
|
- History mode behavior
|
||||||
- `.env.example` for environment-based configuration
|
- UI scrolling
|
||||||
- README with setup, workflow, and template reuse instructions
|
|
||||||
- MIT license
|
## [0.1.0] - 2026-03-14
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Initial release of **cd-browser**
|
||||||
|
- Terminal-based directory navigation
|
||||||
|
- Interactive directory tree navigation
|
||||||
|
- History navigation mode
|
||||||
|
|||||||
47
README.md
47
README.md
@@ -1,24 +1,49 @@
|
|||||||
# cd-browser
|
# cd-browser
|
||||||
|
|
||||||
`cd-browser` is a terminal-native directory navigator for fast filesystem browsing from the command line.
|
**Stop typing paths. Browse them.**
|
||||||
|
|
||||||
It provides an interactive interface for exploring directories with the keyboard and returns the selected path at the end of the session so shell wrappers can change the current shell directory.
|
`cd-browser` is a fast keyboard-driven directory navigator for the terminal.
|
||||||
|
It lets you explore directory trees visually and jump to any folder instantly.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Why cd-browser?
|
||||||
|
|
||||||
|
Working in the terminal often means:
|
||||||
|
|
||||||
|
- typing long directory paths
|
||||||
|
- navigating deep folder trees
|
||||||
|
- repeating `cd ..` multiple times
|
||||||
|
|
||||||
|
`cd-browser` provides an **interactive terminal UI** that allows you to browse directories with the keyboard and return the selected path directly to your shell.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- 🚀 Fast visual navigation of directory trees
|
||||||
|
- ⌨️ Fully keyboard-driven workflow
|
||||||
|
- 🌲 Expand and collapse directories
|
||||||
|
- 📜 Navigation history inside the session
|
||||||
|
- 🖥 Native terminal interface
|
||||||
|
- 🔁 Works with Bash, Zsh and other shells
|
||||||
|
- ⚡ Returns the selected path to the shell
|
||||||
|
|
||||||
|
## Quick Demo
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd_
|
||||||
|
```
|
||||||
|
|
||||||
|
Browse directories using the arrow keys and press **Enter** to jump directly to the selected folder.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
See the documentation index:
|
See the documentation index:
|
||||||
|
|
||||||
|
```
|
||||||
docs/index.md
|
docs/index.md
|
||||||
|
```
|
||||||
## Features
|
|
||||||
|
|
||||||
- Interactive terminal directory browser
|
|
||||||
- Keyboard-driven navigation
|
|
||||||
- Parent directory entry via `..`
|
|
||||||
- Expand and collapse directory trees
|
|
||||||
- Session navigation history support in the application state
|
|
||||||
- Installable CLI command: `cd_browser`
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user