Quick Start guide to Hosted Cyclid

You’ve just signed up for a hosted Cyclid account. Great! Now what? This article explains how to get yourself configured and get started.

Hopefully you found the signup process straightforward. You confirmed your email address. Great news, your hosted Cyclid account has been created! You can log in straight away, if you’d like.

Create an Organization

You can’t do much with Cyclid without an Organization, so one of the first things you should do is create one. When you create an Organization, you’ll need to choose a plan. You don’t need to enter any Credit Card details if you’re creating an Organization with a Free plan.

If you’d like to more information on how Organizations work with Cyclid, this article should be helpful.

To create an Organization, go ahead an log in. Once you’re logged in, open the “Organizations” menu and select “Manage your Organizations” to open your account management page. Here you can add Credit Card details (for paid plans), and create and delete Organizations. To create a new Organization click on “New”, enter a name for your new Organization and select a plan. Your new Organization will be created immediately.


Install the Command Line client

The web interface is a quick and easy way to use Cyclid, but you’ll almost certainly want to install and configure the Command Line client to get the most out of Cyclid.

The client is a small Ruby application. You will need Ruby 2.1 or newer installed. To install the client, just install the Gem:

$ gem install cyclid-client

The Gem will be downloaded from Rubygems and installed.

Once the client is installed, you can authenticate against Cyclid and it will automatically create the configuration files, one for every Organization you belong to:

$ cyclid user authenticate
Username: vanders
Authenticating vanders with https://api.cyclid.io
Creating configuration file for organization cyclid
$ cyclid org list
	URL: https://api.cyclid.io
	Organization: cyclid
	Username: vanders
$ cyclid org use cyclid

Your list or Organizations will be different, of course. Once you’ve selected an Organization with the `org use` command, you can check if everything has worked with a simple command such as `org show`.

You can read the documentation for the Client if you’d like to learn more about how to use it to interact with Cyclid. Note that the `admin` commands won’t work with Hosted Cyclid, as they are intended for server administrators.

Connect Cyclid with Github

Continuous Integration is useful for applying tests to your software automatically. You can easily connect your Cyclid Organization to your Github repositories. Cyclid will work with both Public & Private repositories; even for Free plan users!

Check out the examples

We’ve put together a few example projects that show you how to write Cyclid jobs for various different languages. They’re a good place to get started; you can even run them on your hosted Cyclid account if you’d like to see what they do.

Join the Slack channel

When you sign up for Cyclid, we’ll automatically invite you to the Cyclid community Slack channel. When you join you can get support, ask questions, and talk to other Cyclid users and developers.

Read the documentation

There is extensive documentation that covers every aspect of using and running Cyclid, so you should be able to find what you need there. There’s also this series of blogs which often include useful articles and introductions to Cyclid features.

Open bug reports

If you’ve had any problems getting started with Cyclid, please let us know by opening a bug report so that we can fix it: