Skip to content

tryingET/typrepl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Typst REPL

An interactive REPL (Read-Eval-Print Loop) for Typst document authoring.

Installation

# Clone the repository
git clone <repo-url> typrepl
cd typrepl

# Run installer
./install.sh

# Or manually:
cp bin/typrepl ~/bin/
cp bin/typst-* ~/bin/
mkdir -p ~/.config/typrepl
cp -r share/* ~/.config/typrepl/

Tools

Tool Description
typrepl Interactive REPL
typst-tui Terminal UI (requires fzf)
typst-new Create projects from templates
typst-compile Compile documents
typst-convert Convert formats

Quick Start

# Start REPL
typrepl

# Create and open project
typrepl new mypaper paper
typrepl open mypaper

# List projects
typrepl list

# Inside REPL
typ[pdf]> :help        # Show commands
typ[pdf]> :template    # Load template
typ[pdf]> :snips       # List snippets
typ[pdf]> :q           # Quit

Commands

Projects

  • :new <name> - Create project
  • :open <name> - Open project
  • :close - Close project
  • :projects - List projects

Document

  • :show - Show document
  • :compile - Compile to PDF
  • :format - Format code
  • :analyze - Show statistics

Templates

  • :template paper - Academic paper
  • :template thesis - Thesis
  • :template letter - Letter
  • :template slides - Presentation

Mode

  • :text - Terminal output
  • :pdf - PDF viewer
  • :server - Live web preview

Other

  • :git init/commit/log - Git integration
  • :bib add/list - Bibliography
  • :snap/save/restore - Version snapshots
  • :session save/load - Session management

Plugins

Load with :plugin <name>:

  • math - Math helpers, calculator
  • code - Code blocks
  • images - Image handling
  • tables - Table generation
  • diagrams - Flowcharts, timelines
  • writing - Focus timer
  • stats - Statistics
  • present - Presentation helpers
  • latex - LaTeX compatibility
  • outline - Document structure
  • review - Comments and TODOs
  • format - Styling helpers

Configuration

~/.config/typrepl/
├── projects/      # Your projects
├── plugins/       # Custom plugins
├── snippets/      # Custom snippets
├── themes/        # Color themes
├── sessions/      # Saved sessions
└── history/       # Version snapshots

Requirements

  • typst - Typst compiler
  • fzf - For TUI (optional)
  • bat - Syntax highlighting (optional)
  • pandoc - Format conversion (optional)

License

MIT

About

Interactive Typst document authoring REPL

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages