FunnelEnvy / optimizely-cli

Faster Optimizely experiment development. Code locally and publish to Optimizely through the API.
http://www.funnelenvy.com/optimizely-cli/
Apache License 2.0
54 stars 17 forks source link

Optimizely Command Line Interface

Codeship Status for FunnelEnvy/optimizely-cli
Code Climate Test Coverage

Working with Optimizely X? Check out the Optimizely X CLI from @teamroboboogie!

Optimizely-CLI (optcli) is a command line tool that lets developers build experiments faster by using the sofware tools you already love and publish to Optimizely when ready. We build a lot of tests at FunnelEnvy and found that (being stubborn engineers) we were more comfortable using our source editors and Git to develop locally - and this had a significant positive impact on our test velocity.

Optimizely-cli includes a command line executable that also integrates with either theTampermonkey (Google Chrome) or Greasemonkey (Firefox) extensions for local development / preview and the Optimizely API for publishing tests.

Brief intro below - for more usage details check out our Optimizely-CLI page.

Installation

npm install -g optimizely-cli

This will install the optcli executable on your system.

Dependencies

You'll need to have node.js installed locally to run optcli and either the Tampermonkey or Greasemonkey extensions to view variations locally.

Quickstart

optcli

View available commands

optcli init [options] [project_id]

Initializes a new Optimizely project locally (use -r for remote).

optcli experiment <folder> <description> <url>

Create a local experiment

optcli variation <experiment> <folder> <description>

Create a local variation

optcli host [options] <path> [port]

Host a variation locally. Point your browser at http(s)://localhost:8080 (default port) for usage info.

optcli push-experiment <path>

Push a local experiment to Optimizely.

optcli push-variation <path>

Push a local variation to Optimizely

Known Issues

Release History

Contributing

Please see CONTRIBUTING.md.

Copyright and license

Code copyright 2015 Celerius Group Inc. Released under the Apache 2.0 License.