Skip to content

fredcamaral/slicli

BranchesTags

Repository files navigation

SliCLI 🎯

A powerful, zero-configuration CLI slide generator that transforms Markdown into beautiful presentations

Go Version License Open Source

🚀 Quick Start

# Install slicli (choose one method)
# From GitHub Releases (recommended)
curl -sSL https://github.com/fredcamaral/slicli/releases/latest/download/slicli-linux-amd64.tar.gz | tar xz
sudo mv slicli /usr/local/bin/

# Or using Go
go install github.com/fredcamaral/slicli/cmd/slicli@latest

# Initialize a new presentation
slicli init my-presentation --template basic --title "My First Slides"
cd my-presentation

# Or create manually
echo "# Hello World\n\nWelcome to SliCLI!" > presentation.md

# Serve and view
slicli serve presentation.md

Your presentation is now live at http://localhost:1000 🎉

✨ Features

Core Capabilities

  • 🚀 Zero Configuration - Start presenting immediately, no build steps required
  • ⚡ Live Reload - Real-time preview with automatic file watching
  • 🎨 15+ Professional Themes - Executive Pro, Developer Dark, Academic Research, and more
  • 🔌 Plugin System - Extensible with Mermaid diagrams, syntax highlighting, and code execution
  • 📱 Mobile Responsive - Perfect rendering on all device sizes
  • 🌐 Offline Ready - No internet required for core functionality

Advanced Features

  • 📊 Mermaid Diagrams - Integrated diagram generation
  • 💻 Live Code Execution - Run code snippets in presentations
  • 🎯 Multiple Export Formats - PDF, PNG images, HTML, and Markdown exports
  • 🔧 Custom Themes - CSS-based theming with CLI color/font overrides
  • 🏪 Community Marketplace - Browse and install community plugins and themes
  • 🎤 Presenter Mode - Speaker notes, timer, and next slide preview
  • ⌨️ Keyboard Shortcuts - Full keyboard navigation with help modal
  • 📺 Fullscreen Mode - Distraction-free presentation viewing

📦 Installation

From Source

git clone https://github.com/fredcamaral/slicli.git
cd slicli
make build
sudo make install

Using Go Install

go install github.com/fredcamaral/slicli/cmd/slicli@latest

GitHub Releases (Pre-built Binaries)

Download the latest release for your platform from GitHub Releases:

  • slicli-vX.X.X-linux-amd64.tar.gz
  • slicli-vX.X.X-linux-arm64.tar.gz
  • slicli-vX.X.X-darwin-amd64.tar.gz (macOS Intel)
  • slicli-vX.X.X-darwin-arm64.tar.gz (macOS Apple Silicon)
  • slicli-vX.X.X-windows-amd64.zip

All releases include SHA256 checksums for verification.

🛠️ CLI Commands

Initialize a New Presentation

# Create in new directory with defaults
slicli init my-presentation

# Create with specific template and theme
slicli init my-presentation --template pitch --theme startup-pitch

# Available templates: basic, technical, pitch, academic
slicli init --template technical --title "API Architecture" --author "Jane Doe"

# Initialize in current directory
slicli init .

Serve Presentations

# Basic serve
slicli serve presentation.md

# With custom port and theme
slicli serve presentation.md --port 8080 --theme developer-dark

# With presenter mode (separate port for speaker view)
slicli serve presentation.md --presenter-port 9090
# Main view: http://localhost:1000
# Presenter view: http://localhost:9090/presenter

# With theme color overrides
slicli serve presentation.md --theme executive-pro \
  --override-primary "#ff5500" \
  --override-text "#222222"

Export Presentations

# Export to PDF
slicli export presentation.md --format pdf --output slides.pdf

# Export to PNG images
slicli export presentation.md --format images --output ./slides/

# Export to HTML (single file)
slicli export presentation.md --format html --output presentation.html

# Export with options
slicli export presentation.md --format pdf \
  --theme executive-pro \
  --quality high \
  --page-size A4 \
  --orientation landscape

Manage Themes

# List all available themes
slicli themes list

# Get detailed info about a theme
slicli themes info executive-pro

# JSON output for scripting
slicli themes list --json

Configuration Management

# Show active configuration with sources
slicli config show

# Show config for specific presentation directory
slicli config show --path ./my-presentation

# Create local configuration file
slicli config init

# Create global configuration
slicli config init --global

# Validate configuration
slicli config validate

🎨 Available Themes

SliCLI comes with 15+ professionally designed themes:

Theme Best For Style
Executive Pro C-suite presentations Corporate, professional
Developer Dark Technical presentations Dark mode, code-focused
Academic Research Scholarly presentations Clean, academic
Startup Pitch Investor presentations Modern, bold
Modern Minimal Clean presentations Minimalist, elegant
Healthcare Pro Medical presentations Professional, accessible
Finance Pro Financial presentations Data-focused, charts
Education Plus Teaching materials Friendly, educational
Creative Studio Design presentations Colorful, creative
Scientific Pro Research presentations Technical, structured
Corporate Pro Business presentations Professional, corporate
TechConf Pro Conference talks Technical, modern
Default General purpose Clean, versatile
Minimal Content-focused Distraction-free
Dark Low-light environments Modern dark theme 
# Use a specific theme
slicli serve --theme executive-pro presentation.md

# List all available themes
slicli themes list

🔌 Plugin System

Built-in Plugins

  • Mermaid - Generate diagrams from text
  • Syntax Highlight - Beautiful code highlighting
  • Code Exec - Live code execution

Using Plugins in Markdown

```mermaid
graph TD
    A[Start] --> B[Process]
    B --> C[End]
```

```go
package main

import "fmt"

func main() {
    fmt.Println("Hello, SliCLI!")
}
```

Plugin Marketplace

# Browse available plugins
slicli marketplace list

# Search for plugins
slicli marketplace search diagram

# Install a plugin
slicli marketplace install plugin-name

# Get plugin information
slicli marketplace info plugin-name

📝 Creating Presentations

Basic Markdown Structure

---
title: "My Presentation"
author: "Your Name"
theme: "executive-pro"
---

# Welcome Slide

Your content here

---

# Second Slide

More content

- Bullet points
- Are supported
- Out of the box

Advanced Features

# Code Execution
```bash exec
echo "This code will run live!"
```

# Mermaid Diagrams
```mermaid
sequenceDiagram
    Alice->>Bob: Hello Bob, how are you?
    Bob-->>Alice: I am good thanks!
```

# Syntax Highlighting
```go
func main() {
    fmt.Println("Beautifully highlighted!")
}
```

Speaker Notes

Add speaker notes that only appear in presenter mode:

# My Slide Title

This is the visible content.

<!-- Notes:
These notes only appear in presenter view.
- Remember to mention the demo
- Ask for questions after this section
-->

---

# Next Slide

⌨️ Keyboard Shortcuts

Press ? or H during a presentation to see all shortcuts:

Key Action
← / → Previous / Next slide
Home / End First / Last slide
1-9, 0 Jump to slide 1-10
G Go to specific slide (enter number)
F Toggle fullscreen
B or . Blank/black screen (toggle)
? or H Show keyboard shortcuts help
Escape Exit fullscreen / Close modal
Space Next slide
PageUp / PageDown Previous / Next slide

🎤 Presenter Mode

Start a presentation with presenter mode to get a speaker view with notes, timer, and next slide preview:

# Enable presenter mode on port 9090
slicli serve presentation.md --presenter-port 9090

URLs:

  • Audience view: http://localhost:1000 (main presentation)
  • Presenter view: http://localhost:9090/presenter

Presenter View Features:

  • Current slide (large view)
  • Next slide preview
  • Speaker notes (from <!-- Notes: ... --> comments)
  • Elapsed time since start
  • Current time
  • Slide counter
  • Navigation controls
  • WebSocket sync (presenter controls audience view)

🎨 Theme Customization

Override theme colors and fonts without editing CSS:

slicli serve presentation.md --theme executive-pro \
  --override-primary "#ff5500" \
  --override-secondary "#00aaff" \
  --override-background "#ffffff" \
  --override-text "#222222" \
  --override-font-heading "Montserrat, sans-serif" \
  --override-font-body "Open Sans, sans-serif" \
  --override-font-size "18px"

This injects CSS custom properties that override the theme defaults.

⚙️ Configuration

CLI Options

slicli serve [file] [flags]

Flags:
  --host string       Server host (default "localhost")
  --port int         Server port (default 1000)
  --theme string     Theme name (default "default")
  --config string    Config file path
  --no-browser      Don't auto-open browser

Configuration File (slicli.toml)

[server]
host = "localhost"
port = 1000
auto_open = true

[theme]
name = "executive-pro"

[plugins]
enabled = true
whitelist = ["mermaid", "syntax-highlight"]

[metadata]
author = "Your Name"
company = "Your Company"

🏗️ Architecture

SliCLI follows Clean Architecture principles with a Hexagonal (Ports & Adapters) pattern:

├── cmd/                    # CLI entrypoints
├── internal/
│   ├── adapters/          # External interfaces
│   │   ├── primary/       # HTTP handlers, parsers
│   │   └── secondary/     # File system, plugins, themes
│   ├── domain/           # Business logic
│   │   ├── entities/     # Core models
│   │   ├── ports/        # Interface definitions
│   │   └── services/     # Business services
│   └── pkg/              # Shared utilities
├── plugins/              # Plugin implementations
├── themes/               # Theme definitions
└── examples/             # Sample presentations

🛠️ Development

Prerequisites

  • Go 1.24.4+
  • Make

Development Workflow

# Format code
make fmt

# Run tests
make test

# Security scan
make lint

# Build project
make build

# Run with example
make run

Plugin Development

# Create a new plugin from template
cp -r examples/plugin-template plugins/my-plugin
cd plugins/my-plugin

# Implement your plugin logic in main.go
# Build the plugin
make build

# Test your plugin
make test

🤝 Contributing

We welcome contributions! SliCLI is fully open source and community-driven.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes following our coding standards
  4. Run quality checks (make fmt test lint)
  5. Commit your changes (git commit -m 'feat: add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Coding Standards

  • Follow Go best practices and conventions
  • Maximum 50 lines per function
  • Comprehensive error handling
  • Security-first approach
  • 100% test coverage for new features

📊 Performance

SliCLI is designed for speed and efficiency:

  • Fast Startup: < 100ms initialization
  • Live Reload: < 50ms file change detection
  • Memory Efficient: < 50MB RAM usage
  • Plugin Loading: < 10ms per plugin
  • Theme Switching: Instant CSS swapping

🔒 Security

Security is a core principle:

  • Input Sanitization: HTML sanitization with BlueMonday
  • Plugin Sandboxing: Isolated plugin execution
  • Dependency Scanning: Regular vulnerability checks
  • Static Analysis: gosec security scanning
  • Safe Defaults: Secure-by-default configuration

📚 Examples

Check out the /examples directory for:

  • Simple Presentation - Basic markdown slides
  • Theme Showcase - Demonstration of all themes
  • Plugin Usage - Advanced plugin examples
  • Custom Theme - Create your own theme
  • Plugin Template - Plugin development starter

🗺️ Roadmap

Current Focus (Open Source Community)

  • ✅ Core slide generation and theming
  • ✅ Plugin system with marketplace
  • ✅ 15+ professional themes
  • ✅ Live reload and development experience
  • 🔄 Community plugin contributions
  • 🔄 Enhanced export formats
  • 🔄 Mobile presentation controls

Future Enhancements

  • Interactive slide elements
  • Collaborative editing
  • Advanced animation system
  • Integration with popular tools
  • Cloud synchronization (optional)

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Go Community - For the excellent tooling and ecosystem
  • Goldmark - Powerful Markdown processing
  • Cobra - CLI framework excellence
  • Contributors - Everyone who helps make SliCLI better

Built with ❤️ by the open source community

⭐ Star us on GitHub | 🐛 Report Issues | 💬 Join Discussions

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages