

New to pantograph? Click here to open the installation & setup instructions first

1) Install the latest Xcode command line tools

xcode-select --install

Install _pantograph_ using Homebrew & Rubygems

# Install ruby via homebrew (macOS & linux only)
brew install ruby

# Set ruby in your shell path (example uses Zsh)
echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.zshrc

# Using RubyGems
gem install pantograph

3) Navigate to your project and run

pantograph init

More Details

Other

Other advanced topics that didn't fit anywhere else:

Environment Variables

You can define environment variables in a .env or .env.default file in the same directory as your Pantfile. Environment variables are loaded using dotenv. Here's an example:

POM_PATH=pom.xml
ARTIFACTORY_API_TOKEN=your-artifactory-api-token

pantograph also has a --env option that allows loading of environment specific dotenv files. .env and .env.default will be loaded before environment specific dotenv files are loaded. The naming convention for environment specific dotenv files is .env.<environment>

For example, pantograph <lane-name> --env development will load .env, .env.default, and .env.development

Alternatively, as environment variables are not a pantograph specific thing, you can also use standard methods to set them:

MY_USER='johnny@example.com' pantograph test

or

export MY_USER='johnny@example.com'
pantograph test

Although it kind of defeats the purpose of using them in the first place (not to have their content in any files), you can also set them in your Pantfile:

ENV['MY_USER'] = 'johnny@example.com'