asciinema/asciinema
Asciinema
Asciinema is a platform for capturing, replaying, and sharing command-line sessions. It provides a comprehensive suite of tools to record terminal activity into lightweight, text-based files that preserve ANSI escape sequences, allowing users to document technical workflows, troubleshooting steps, and software demonstrations with high fidelity.
The project distinguishes itself through its versatile playback and distribution capabilities. It features a web-based player that renders interactive terminal sessions directly in the browser, supporting features like seeking, playback speed control, and custom visual themes. Beyond interactive playback, it includes utilities for converting recordings into animated images or videos, and provides infrastructure for self-hosting recording servers to maintain full control over data storage and security.
The platform supports a wide range of integration and automation needs, including embedding interactive sessions into technical documentation, broadcasting live terminal activity to remote viewers, and programmatically generating recordings via scripts. It also offers robust management tools for indexing, searching, and organizing historical session data.
The software is designed for flexible deployment, with server and storage components packaged into containerized units for independent hosting.
Features
- Terminal Session Recorders - Captures terminal input and output into lightweight files for recording shell sessions.
- Web-Based Recorders - Renders interactive terminal sessions directly in the browser with playback controls and custom themes.
- ANSI Escape Sequence Renderers - Interprets ANSI escape sequences to accurately replicate terminal text, colors, and cursor movements in web browsers.
- Playback Controllers - Provides interactive controls for pausing, resuming, and seeking through recorded terminal sessions.
- Browser-Based Terminal Players - "Replicates the terminal display layer within a web browser to enable interactive playback and text selection of recorded sessions."
- Session Servers - Provides self-hosted infrastructure for storing, managing, and broadcasting live or recorded command-line sessions.
- Self-Hosted Infrastructure - Deploying private server instances to store, manage, and share terminal session data while maintaining full control over security and storage.
- Terminal Session Serializers - "Encodes terminal activity into a stream of time-stamped events and metadata for efficient storage and sequential playback."
- Terminal Session Broadcasters - Streaming real-time command-line sessions to remote viewers for collaborative debugging, pair programming, or live technical presentations.
- Terminal Escape Sequence Parsers - "Parses raw terminal output streams to accurately reconstruct text, color, and cursor movements within diverse rendering environments."
- Terminal Format Parsers - Supports native and legacy terminal recording formats through an extensible parsing architecture.
- Streaming and Broadcasting - Broadcasts terminal activity in real-time to remote viewers using network protocols.
- Component Embedding - The platform generates portable player components and preview images for embedding interactive terminal recordings into external websites and documentation.
- CLI Utilities - Terminal session recording tool.
- Shells and Command Line - Terminal session recorder and replayer for sharing command-line workflows.
- Image Processing - Record and share terminal sessions.
- Media and Communication Tools - Terminal session recorder.
- Screen Recording - Terminal session recording tool.
- Documentation and Knowledge - Records and replays terminal sessions in the browser.
- Self-Hosted Deployment Infrastructure - "Packages the server and storage components into portable units to allow independent deployment and full data ownership."
- Interactive Terminal Embeds - Embedding interactive terminal sessions into websites and documentation to provide clear, copyable, and reproducible command-line examples.
- Real-Time Data Streams - "Facilitates low-latency broadcasting of terminal sessions by pushing event streams directly from the host to connected remote viewers."
- Session Recording - Provides tools for modifying session files, including trimming content and adjusting playback speed.
- Animation Converters - Transforms recorded terminal sessions into animated GIF or video files for embedding in documentation and presentations.
- Self-Hosted Backend Configurations - Supports directing terminal recordings to custom or self-hosted server instances via configuration.
- Terminal Customization - Provides configuration for terminal themes, font families, and rendering backends to control aesthetic output.
- Session Media Renderers - The platform renders terminal session recordings into animated image files or videos, supporting various input sources and output formats.
- Session Recording Management - The platform offers API access to upload, organize, and retrieve terminal session recordings for historical auditing and review.
- Terminal Transcripts - Converts recorded terminal sessions into plain text files for raw command-line output extraction and analysis.
- Search & Indexing Engines - Indexes the full text of recorded terminal sessions to enable rapid discovery of specific commands or output.
- Terminal Playback Engines - "Manages the temporal progression of terminal sessions by processing event buffers and synchronizing visual updates with playback controls."
- Recording Converters - Transforming text-based command-line logs into animated images or videos for easy sharing on platforms that do not support interactive players.
- Playback Event Hooks - Allows developers to register custom handlers for specific actions or state changes during terminal session playback.
- Streaming APIs - The platform provides API endpoints to create, update, and manage real-time streaming sessions for collaborative troubleshooting or live demonstrations.
- Server Management Interfaces - Provides an administrative interface for overseeing server operations, configuration, and service management.
- oEmbed Providers - The platform provides oEmbed endpoints that allow external platforms to automatically fetch and render recording previews using standard web protocols.
- Lifecycle Managers - Enforces upload size limits, defines custom storage paths, and automates the removal of unclaimed recordings.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
