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 (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 (generates paper/aesthetics.typ + paper/paper.typ)
  • blank: minimal empty Typst file

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.7.tar.gz (14.9 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.7-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

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

Hashes for blank_agentic_cli-0.1.7.tar.gz
Algorithm Hash digest
SHA256 517c389ced6f479888f1cdaa7c89eab3616c669d16eac8881c7aba7318e7ca03
MD5 968511a2be656c4f3314e0a560545a93
BLAKE2b-256 700ff574cb527862a6d7b348cf31a6e24a140cab5e53cf457ab6d80fd5281f14

See more details on using hashes here.

Provenance

The following attestation bundles were made for blank_agentic_cli-0.1.7.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.7-py3-none-any.whl.

File metadata

File hashes

Hashes for blank_agentic_cli-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4768614e5e8cd951865cb1ee2ee38829c6c9d2d2432a9fa4ccada93d1bae1582
MD5 92adcd45cf3f9dabc3b5e1e212c810fb
BLAKE2b-256 ddfc2c4304ceb683a5b59c81fc127fe9796c5f01489e0ab7128fe1c18544f541

See more details on using hashes here.

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

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