This project provides a command line interface for pushing and pulling code to optimizely via the command line. This is especially useful for proper version control and peer review of A/B testing code that gets launched through Optimizely.

This project is forked from Optimizely-CLI, a command line tool that lets developers build Optimizely experiments faster. The package was originally developed by the folks at FunnelEnvy who found that (being stubborn engineers) they were more comfortable using our source editors and Git to develop locally - and this had a significant positive impact on their test velocity.

Optimizely Sync leaves in features from Optimizely-CLI, including a command line executable that also integrates with either the Tampermonkey (Google Chrome) or Greasemonkey (Firefox) extensions for local development / preview and the Optimizely API for publishing tests.

For more info on FunnelEnvy's Optimizely-CLI, check out their Optimizely-CLI page.

Installation

npm install -g optimizely-sync

This will install the optimizely executable on your system.

Dependencies

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

Quickstart

optimizely

View available commands

optimizely init [options] [project_id]

Initializes a new Optimizely project locally (use -r to set up from a pre-existing remote). -j will include a smaller jquery for your experiments to use (loaded by Optimizely with .noConflict())

optimizely pull [<experiment>|<experiment> <variation>]

Pulls changes from optimizely to the specified variation, experiment (all variations), or all experiments within the project.

Experiment and Variation specific pulling is NOT IMPLEMENTED yet

optimizely push [<experiment>|<experiment> <variation>]

Pushes changes from your local file system to Optimizely following the same rules as optimizely pull

Experiment and Variation specific pushing is NOT IMPLEMENTED yet

optimizely new-experiment <experiment> <description>

NOT IMPLEMENTED Checks to see if this experiment exists in Optimizely and pulls it into your working tree (where appropriate), otherwise creates a new experiment to be pushed later.

optimizely new-variation <experiment> <variation-number> <description>

NOT IMPLEMENTED Checks to see if this variation exists in the specified experiement in Optimizely and pulls it into your working tree (where appropriate), otherwise creates a new variation to be pushed later.

optimizely host [options] <path> [port]

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

Known Issues

Tests - We have some. We're adding more.

Release History

0.20.0 Changed to Optimizely Sync. Changed binary name. -- Fork --
0.15.0 Iteration option on push-experiment
0.14.3 Added push-experiment, push-variation tests
0.14.2 Show help when no arguments passed
0.14.1 Bugfixes
0.14.0 Move node client into separate module
0.12.0 Bugfixes, more compliant with semver
0.0.11 Separated create from push operations
0.0.10 Refactored and cleanup
0.0.7 Push
0.0.2 Clone bug fix
0.0.1 Initial release

Contributing

Please see CONTRIBUTING.md.

Copyright and license

All other registered trademarks or trademarks are property of their respective owners.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.