Skip to main content

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:

  1. Install pipx (if missing):
python3 -m pip install --user pipx
python3 -m pipx ensurepath
  1. Reload your shell:
exec $SHELL -l
  1. Install blank from 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.md with default agent rules
  • .codex/config.toml with Zotero + PDF-reader MCP server setup
  • .codex/skills/ starter skill set and install scripts
  • .claude/ defaults

MCP setup (Zotero + PDF reader)

Generated projects include:

  • zotero MCP server via zotero-mcp
  • pdf_reader MCP server via uvx 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)

  1. Create PyPI project blank-agentic-cli and enable Trusted Publishing for this GitHub repo.
  2. (Optional) Run GitHub Action publish manually with testpypi to verify packaging.
  3. Tag a release:
git tag v0.1.0
git push origin v0.1.0
  1. The publish workflow builds and uploads to PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blank_agentic_cli-0.1.8.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blank_agentic_cli-0.1.8-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

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

Hashes for blank_agentic_cli-0.1.8.tar.gz
Algorithm Hash digest
SHA256 581b7c05097b7df43fdd248096c6df09270750250977270493e6ac9c8fff061c
MD5 b4010aa12907f342718cf176266c70bb
BLAKE2b-256 10e46df80cb50ae6881d66bee625ccf4f690d40c77fb5da981f4c650fbdd905d

See more details on using hashes here.

Provenance

The following attestation bundles were made for blank_agentic_cli-0.1.8.tar.gz:

Publisher: publish.yml on shusuke-ioku/blank

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file blank_agentic_cli-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for blank_agentic_cli-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 153e6000e8b5ff82fd12e0d66ac6ea7da7da2c8f742e9a3cd9a2aaae30150652
MD5 e72e817759c01f15a0c520f44e0960c7
BLAKE2b-256 bed418799d2de8dbe5cbccb2bc84475dca6cc3cad78c5707bbfe5dc5ae3d786a

See more details on using hashes here.

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page