Skip to content

Installation

Prerequisites

  • Ruby 3.2 or later
  • Bundler gem
  • Git

Installation Steps

1. Clone the Repository

git clone https://github.com/madbomber/sqa-cli.git
cd sqa-cli

2. Install Dependencies

Install the required Ruby gems:

bundle install

3. Install SQA Gem Dependencies

The SQA gem needs its dependencies installed:

cd ../sqa/main && bundle install && cd -

4. Make Executable

Ensure the CLI is executable:

chmod +x bin/sqa-cli

5. Verify Installation

Check that everything is working:

# Show version
bundle exec ./bin/sqa-cli version

# Run tests
bundle exec rake test

You should see: 

sqa-cli version 0.1.0

And all tests should pass: 

8 tests, 21 assertions, 0 failures

Optional: Add to PATH

To use sqa-cli from anywhere, add the bin directory to your PATH:

# Add to ~/.bashrc or ~/.zshrc
export PATH="/path/to/sqa-cli/bin:$PATH"

Then you can run: 

sqa-cli version

Troubleshooting

Missing Gems

If you see errors about missing gems, make sure both projects have their dependencies installed:

# In sqa-cli directory
bundle install

# In SQA gem directory
cd ../sqa/main
bundle install

Permission Denied

If you see "Permission denied" when running the CLI:

chmod +x bin/sqa-cli

Ruby Version Issues

Check your Ruby version:

ruby -v

If it's below 3.2, consider using a Ruby version manager like rbenv or rvm to install a newer version.

Next Steps