Ruby SDK for Lokalise API

Opinionated Ruby SDK for the Lokalise Vantage API.

The lokalise-api-next gem provides a Ruby interface for working with Lokalise Vantage resources. It handles authentication, HTTP requests, response parsing, and API errors, and returns Ruby models and collections.

• Ruby 3.4 or newer
• A Lokalise API token with access to Vantage

Add the gem to your Gemfile:

gem 'lokalise-api-next'

Then run:

bundle install

Create a client using your Lokalise API token:

require 'lokalise_api_next'

client_vantage = LokaliseApiNext.client_vantage(
  ENV.fetch('LOKALISE_VANTAGE_TOKEN')
)

For example, retrieve a project:

project = client_vantage.project('project-id')

puts project.name
puts project.description

Or list projects belonging to a team:

projects = client_vantage.projects('team-id', limit: 20)

projects.each do |project|
  puts "#{project.project_id}: #{project.name}"
end

The SDK also supports configurable timeouts, automatic retries, proxies, and persistent HTTP connections.

See the GitHub Wiki for usage examples, client configuration, pagination, and available API operations.

Clone the repository and install dependencies:

bundle install

Run the test suite:

bundle exec rspec

Run RuboCop:

bundle exec rubocop

The tests use RSpec and WebMock to simulate API responses, so a real API token is not required.

(c) 2026 Lokalise group, Elijah S. Krukowski, BSD 3 Clause license.