Project

rapicco

0.0
No release in over 3 years
A wrapper tool of PicoRuby Rapicco terminal-based presentation
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

~> 1.17
~> 13.0
 Project Readme

Rapicco

Test

A wrapper tool of PicoRuby Rapicco terminal-based presentation.

Overview

Rapicco is a tool that shows presentation slide on terminal emulator by running picoruby process. It also converts Rapicco presentations into PDF documents capturing the ANSI terminal output from Rapicco and renders it as a high-quality PDF.

Requirements

  • Ruby (you can see supported versions in rapicco.gemspec)
  • Cairo graphics library
  • PicoRuby with Rapicco installed
    • export PICORUBY_PATH=path/to/picoruby needs to be set

Installation

gem install rapicco

Usage

Create a presentation project (recommended)

  1. Create a new presentation project along with mkdir:
rapicco new my-presentation
cd my-presentation

Or in existing directory,

cd my-presentation
rapicco new .

Warning

The above command will override existing files.

This generates:

  • Gemfile with rapicco gem
  • Rakefile with presentation tasks
  • slide.md template
  • config.yaml configuration
  • README.md template
  • .gitignore
  1. Install dependencies:
bundle install
  1. Use rake tasks to manage your presentation:
bundle exec rake -T

Available tasks:

rake gem      # Create gem package
rake pdf      # Generate PDF
rake publish  # Publish gem to RubyGems.org
rake run      # Run presentation

Show presentation:

bundle exec rake run

Generate PDF:

bundle exec rake pdf

Create gem package:

bundle exec rake gem

Using CLI directly

Show presentation:

bundle exec rapicco input.md

Generate PDF:

bundle exec rapicco --print input.md

How it generates PDF

  1. Executes Rapicco with the input markdown file
  2. Captures each page of the presentation via PTY
  3. Parses ANSI escape sequences (colors, cursor positioning, block characters)
  4. Renders each page to PDF using Cairo graphics library
  5. Combines all pages into a single PDF document

License

Copyright © 2025 HASUMI Hitoshi. See MIT-LICENSE for further details.