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

Uploaded Python 3

File details

Details for the file blank_agentic_cli-0.1.6.tar.gz.

File metadata

  • Download URL: blank_agentic_cli-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 d8a3e1761cbdd16e5dc8b915bb6fdc52ad7a76420e83da6660247d28195a50c0
MD5 012508c4ce9114540941f9b979260f15
BLAKE2b-256 402116f38e5321d31de2a4057ce092b4cbbb0494fa841b219d30c6e79eafc86e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for blank_agentic_cli-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b1f9aa941b200377ff5e1b2302ca60323596784ea4eedb01d785d19b1699f55f
MD5 2bf9cf5c1f5e90abe13e651a1bdaee22
BLAKE2b-256 b52ef7e4714dc293b25a6f31c7dbd03e78e35dee818a8cebf78ad389163584b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for blank_agentic_cli-0.1.6-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