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

From PyPI (after release):

pipx install blank-agentic-cli

From GitHub:

pipx install git+https://github.com/shusuke-ioku/blank.git

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: LaTeX-like Typst starter
  • 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.1.tar.gz (10.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.1-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: blank_agentic_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 10.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.1.tar.gz
Algorithm Hash digest
SHA256 27279a0cb85fa4e3b69fbcc58669320bcdf3c8a7ccc6ee344988d55ca8668d3f
MD5 0ce5d6a33e09435afb3bd12b6ee7f8e9
BLAKE2b-256 be6daf7dd7a239e5ac495d76be09ae885763409f1899fb1adb982bb4e5164d08

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for blank_agentic_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00b4641772382582ad82424ae88b12fc2e8c3dc20cb14686803d42f150205dd5
MD5 eefa17c2a253c246e350e768bcc88402
BLAKE2b-256 8f85d47e0728f6f6c50853fd6ed9f7bc946f5ea22702616cf75c95e7766015bf

See more details on using hashes here.

Provenance

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