Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 1.79 KB

README.md

File metadata and controls

61 lines (45 loc) · 1.79 KB

cache22

Installation

uv sync
source .venv/bin/activate

Getting Started

# Configure where archives are stored
cache22 config archive add /absolute/path/to/archive

# Optional: switch the default archival format from git to fossil
cache22 config archive-type set fossil

# Import a repository
cache22 import repo https://github.com/ar-jan/cache22.git

By default, imports are treated as Git repositories and stored as Git mirror clones. If you switch the archive type to fossil, cache22 keeps the Git mirror and also creates a Fossil archive alongside it.

If an import is interrupted and leaves partial state behind, clean it up with:

# Clean one repository by URL
cache22 import clean repo https://github.com/ar-jan/cache22.git

# Clean all configured archive directories
cache22 import clean all

Development

# Create .venv and install dependencies
uv sync --group dev
# Install npm dependencies for utils/editor
npm install
# Install git hooks for this repo
uv run --group dev pre-commit install
# Check yaml:
uv run --group dev yamllint docs/related-works.yaml
# Or run all pre-commit hooks:
uv run --group dev pre-commit run --all-files

Related Works Editor

# Run Vite dev server, then open:
# http://127.0.0.1:5173/utils/editor/
npm run editor:dev

If the editor shows File Access: Not supported in this browser in Brave, enable brave://flags/#file-system-access-api and relaunch the browser.

Use Save In Place to write changes back to disk. On first save it will ask you to pick the target YAML file (choose docs/related-works.yaml), then it will reuse that file handle for later saves. The selected file handle is persisted in browser storage; if permission is still granted, the editor auto-loads that same local file on next page load.