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:
curl -fsSL https://raw.githubusercontent.com/shusuke-ioku/blank/main/scripts/install_blank.sh | bash
Alternative: manually install:
- Install
pipx(if missing):
python3 -m pip install --user pipx
python3 -m pipx ensurepath
- Reload your shell:
exec $SHELL -l
- Install
blankfrom PyPI:
pipx install blank-agentic-cli
Verify:
blank --help
Troubleshooting
If blank --help fails with command not found, run:
export PATH="$HOME/.local/bin:$PATH"
hash -r
blank --help
Make it persistent:
# zsh
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
Debug checks:
pipx list
echo "$PATH" | tr ':' '\n' | rg "$HOME/.local/bin"
which blank
ls -l "$HOME/.local/bin/blank"
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
By default, paper/paper.typ imports TeXst:
#import "@preview/texst:0.1.0": paper, nneq, caption-note, table-note, theorem, proof, prop, lem, rem, ass, cmain, csub, caption-with-note
TeXst repository:
paper/aesthetics.typ is intentionally generated as a blank file so you can add custom style settings.
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.8.tar.gz.
File metadata
- Download URL: blank_agentic_cli-0.1.8.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
581b7c05097b7df43fdd248096c6df09270750250977270493e6ac9c8fff061c
|
|
| MD5 |
b4010aa12907f342718cf176266c70bb
|
|
| BLAKE2b-256 |
10e46df80cb50ae6881d66bee625ccf4f690d40c77fb5da981f4c650fbdd905d
|
Provenance
The following attestation bundles were made for blank_agentic_cli-0.1.8.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.8.tar.gz -
Subject digest:
581b7c05097b7df43fdd248096c6df09270750250977270493e6ac9c8fff061c - Sigstore transparency entry: 944706472
- Sigstore integration time:
-
Permalink:
shusuke-ioku/blank@5329ee84aec45027babf149ae81a49f8460164d3 -
Branch / Tag:
refs/tags/v0.1.8 - Owner: https://github.com/shusuke-ioku
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5329ee84aec45027babf149ae81a49f8460164d3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file blank_agentic_cli-0.1.8-py3-none-any.whl.
File metadata
- Download URL: blank_agentic_cli-0.1.8-py3-none-any.whl
- Upload date:
- Size: 17.8 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 |
153e6000e8b5ff82fd12e0d66ac6ea7da7da2c8f742e9a3cd9a2aaae30150652
|
|
| MD5 |
e72e817759c01f15a0c520f44e0960c7
|
|
| BLAKE2b-256 |
bed418799d2de8dbe5cbccb2bc84475dca6cc3cad78c5707bbfe5dc5ae3d786a
|
Provenance
The following attestation bundles were made for blank_agentic_cli-0.1.8-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.8-py3-none-any.whl -
Subject digest:
153e6000e8b5ff82fd12e0d66ac6ea7da7da2c8f742e9a3cd9a2aaae30150652 - Sigstore transparency entry: 944706504
- Sigstore integration time:
-
Permalink:
shusuke-ioku/blank@5329ee84aec45027babf149ae81a49f8460164d3 -
Branch / Tag:
refs/tags/v0.1.8 - Owner: https://github.com/shusuke-ioku
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@5329ee84aec45027babf149ae81a49f8460164d3 -
Trigger Event:
push
-
Statement type: