Runme
lastmod 2026-11-16created 2026-01-262 edits
Runme는 Markdown 문서 안의 펜스 코드 블록을 그대로 실행하는 도구이다. runbook, 운영 문서, README 에 적힌 명령을 복사해 붙이는 대신 셀 단위로 실행하고 중간 결과를 확인하며 따라가게 해 준다. 실행 정보는 코드 블록 옆의 속성으로만 붙고 문서는 Markdown 그대로 남으므로, 기존 문서를 바꾸지 않고도 쓸 수 있다.
About
- 코드 블록에
{ name=update-brew }처럼 이름을 붙여 두고runme run update-brew로 실행함 -
runme list로 문서 안의 실행 가능한 셀을 찾고,runme print로 실행하지 않고 내용만 봄 - 셸(bash, zsh) 외에 Python, Ruby, JavaScript/TypeScript, Lua, PHP, Perl 등은 shebang 으로 실행함
- 터미널 세션처럼 셀 사이에 환경 변수가 유지되고, 앞 셀의 출력을 다음 셀로 파이프할 수 있음
- Makefile, Gradle, Grunt, npm scripts, Pipfile, Deno task 같은 기존 태스크 정의와 함께 쓸 수 있음
- 단계별로 실행 가능한 문서로 만들어 운영 문서가 실제 환경과 어긋나는 문제(bitrot)를 줄이는 것을 목적으로 듦
- Homebrew(
brew install runme), npm,go install, 릴리스 바이너리로 설치. Apache-2.0 라이선스