Table of Contents

• Requirements
• Installation Methods
  • Via RubyGems (Recommended)
  • Via Bundler
  • From Source
• Verification
• Next Steps
• Troubleshooting
  • Command Not Found
  • Permission Errors

Requirements

Sirena requires:

• Ruby 2.7 or higher

• Bundler (for development)

Installation Methods

Via RubyGems (Recommended)

Install Sirena directly from RubyGems:

gem install sirena

Via Bundler

Add Sirena to your Gemfile:

gem 'sirena'

Then install:

bundle install

From Source

Clone the repository and install locally:

git clone https://github.com/claricle/sirena.git
cd sirena
bundle install
bundle exec rake install

Verification

Verify the installation:

sirena version

You should see output similar to:

Sirena version 0.1.0

Next Steps

• Quick Start Guide - Get started with your first diagram

• CLI Reference - Learn all available commands

• Diagram Types - Explore all 24 diagram types

Troubleshooting

Command Not Found

If sirena command is not found after installation, ensure your gem bin directory is in your PATH:

echo 'export PATH="$HOME/.gem/ruby/X.X.0/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Replace X.X.0 with your Ruby version.

Permission Errors

If you encounter permission errors during installation, try:

gem install sirena --user-install

Or use a Ruby version manager like rbenv or rvm.