Singularity Client

Command line tool for easy communication with your Singularity server.

Installation

Add this line to your application's Gemfile:

gem 'singularity_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install singularity_client

Configuration

The singularity client configures itself off a .singularity.yml file.

By default, the tool will start looking for a .singularity.yml in your current working directory, and will work its way up to the root directory. Specify a path via the --config command line option.

Available configurations:

Key Description Type Example
singularity_url URL for the singularity server String 'http://singularity.net'
singularity_port Port the singularity server is operating on String '9000'
github_organization Default github organization to use String 'Behance'

Usage

Commands:
  singularity add REPO_NAME PROJECT_NAME        # Add a github repository to singularity
  singularity comment REPO_NAME PR_NUM COMMENT  # Write comment to a pull request
  singularity config                            # Get the current singularity config object
  singularity help [COMMAND]                    # Describe available commands or one specific command

Options:
  -c, [--config=CONFIG]                      # Specify path to a .singularity.yml file
      [--singularity-url=SINGULARITY_URL]    # Override the default singularity url
      [--singularity-port=SINGULARITY_PORT]  # Override the default singularity port
  -d, [--debug], [--no-debug]                # Turn on debug mode

Contributing

  1. Fork it ( https://github.com/behance/singularity_client/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request