CLI scaffolder for agentic AI research projects
Project description
blank
blank is a CLI scaffolder for research projects driven by agentic AI workflows.
Install
Recommended (handles pipx ensurepath, install, and verification):
curl -fsSL https://raw.githubusercontent.com/shusuke-ioku/blank/main/scripts/install_blank.sh | bash
From GitHub package source (same installer with package override):
curl -fsSL https://raw.githubusercontent.com/shusuke-ioku/blank/main/scripts/install_blank.sh | bash -s -- git+https://github.com/shusuke-ioku/blank.git
From a local clone:
bash scripts/install_blank.sh
First-time pipx setup (one-time per machine):
pipx ensurepath
exec $SHELL -l
From PyPI (after release):
pipx install blank-agentic-cli
From GitHub:
pipx install git+https://github.com/shusuke-ioku/blank.git
Post-install check
blank --help
If you see bash: blank: command not found, pipx likely installed correctly but your shell PATH is missing ~/.local/bin.
Quick fix for current shell:
export PATH="$HOME/.local/bin:$PATH"
hash -r
blank --help
Persist it:
# zsh (default on modern macOS)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zprofile
# bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bash_profile
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
Optional:
pipx ensurepath
Usage
blank init
blank init my-project
blank init my-project --project-name "My Project"
blank init my-project --dry-run
blank init my-project --force
blank init my-project --no-agents
blank init my-project --paper-template latex
blank init my-project --paper-template blank
If --paper-template is omitted and you run in a terminal, blank init asks you to choose:
latex: TeXst-style Typst starter (generatespaper/aesthetics.typ+paper/paper.typ)blank: minimal empty Typst file
Generated scaffold
analysis/scripts/analysis/data/analysis/output/paper/idea/.codex/project.mdwith default agent rules.codex/config.tomlwith Zotero + PDF-reader MCP server setup.codex/skills/starter skill set and install scripts.claude/defaults
MCP setup (Zotero + PDF reader)
Generated projects include:
zoteroMCP server viazotero-mcppdf_readerMCP server viauvx markitdown-mcp
Quick local checks:
zotero-mcp --help
uvx markitdown-mcp --help
Development
python3 -m venv .venv
source .venv/bin/activate
pip install -e . pytest
pytest
Release (PyPI)
- Create PyPI project
blank-agentic-cliand enable Trusted Publishing for this GitHub repo. - (Optional) Run GitHub Action
publishmanually withtestpypito verify packaging. - Tag a release:
git tag v0.1.0
git push origin v0.1.0
- The
publishworkflow builds and uploads to PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file blank_agentic_cli-0.1.7.tar.gz.
File metadata
- Download URL: blank_agentic_cli-0.1.7.tar.gz
- Upload date:
- Size: 14.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
517c389ced6f479888f1cdaa7c89eab3616c669d16eac8881c7aba7318e7ca03
|
|
| MD5 |
968511a2be656c4f3314e0a560545a93
|
|
| BLAKE2b-256 |
700ff574cb527862a6d7b348cf31a6e24a140cab5e53cf457ab6d80fd5281f14
|
Provenance
The following attestation bundles were made for blank_agentic_cli-0.1.7.tar.gz:
Publisher:
publish.yml on shusuke-ioku/blank
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
blank_agentic_cli-0.1.7.tar.gz -
Subject digest:
517c389ced6f479888f1cdaa7c89eab3616c669d16eac8881c7aba7318e7ca03 - Sigstore transparency entry: 942732809
- Sigstore integration time:
-
Permalink:
shusuke-ioku/blank@897d5455649df5d2ed12d14ab9a767fd61994746 -
Branch / Tag:
refs/tags/v0.1.7 - Owner: https://github.com/shusuke-ioku
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@897d5455649df5d2ed12d14ab9a767fd61994746 -
Trigger Event:
push
-
Statement type:
File details
Details for the file blank_agentic_cli-0.1.7-py3-none-any.whl.
File metadata
- Download URL: blank_agentic_cli-0.1.7-py3-none-any.whl
- Upload date:
- Size: 19.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4768614e5e8cd951865cb1ee2ee38829c6c9d2d2432a9fa4ccada93d1bae1582
|
|
| MD5 |
92adcd45cf3f9dabc3b5e1e212c810fb
|
|
| BLAKE2b-256 |
ddfc2c4304ceb683a5b59c81fc127fe9796c5f01489e0ab7128fe1c18544f541
|
Provenance
The following attestation bundles were made for blank_agentic_cli-0.1.7-py3-none-any.whl:
Publisher:
publish.yml on shusuke-ioku/blank
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
blank_agentic_cli-0.1.7-py3-none-any.whl -
Subject digest:
4768614e5e8cd951865cb1ee2ee38829c6c9d2d2432a9fa4ccada93d1bae1582 - Sigstore transparency entry: 942732820
- Sigstore integration time:
-
Permalink:
shusuke-ioku/blank@897d5455649df5d2ed12d14ab9a767fd61994746 -
Branch / Tag:
refs/tags/v0.1.7 - Owner: https://github.com/shusuke-ioku
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@897d5455649df5d2ed12d14ab9a767fd61994746 -
Trigger Event:
push
-
Statement type: