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

Uploaded Python 3

File details

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

File metadata

  • Download URL: blank_agentic_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 14.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.5.tar.gz
Algorithm Hash digest
SHA256 d4b8842359d9a803d7a94c06b0011cb828b30fbd6b6cf6039edf1a5542b3513f
MD5 f586c5bb085f42f937c885f2197fd87b
BLAKE2b-256 d3c7dccb26bb327a6ee9c8728d4ecc88a3e2f98ac9fc13ab75cca31f7f3031e8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for blank_agentic_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c3bfe6eba7eb37d7c580e5c271acf3c48c60af9ad93799f8d26c11e82a4d5d39
MD5 857a903f84766db56487f63dad1a2e24
BLAKE2b-256 c9cbfa14c5e836831e5c8d4d2521fe5633e31fe5ce0b8315ad360c03b8ea457b

See more details on using hashes here.

Provenance

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