Setup an Account

Let's get started!

This setup guide will help get you up and running with Decodable. First, we'll create an account if your organization hasn't yet. Then, we'll install the CLI, log in and get acquainted with some basic commands.

Create an Account

Using Decodable begins with a Decodable Account, which will contain your Decodable resources. An account can have many members, so everyone on your team can share and manage access.

Each account has a Decodable API hostname, used internally by the Decodable CLI.

If your team already has an account, ask them for an invitation!

Otherwise, create an account with the Decodable Web Console. You'll need to provide the following things, none of which (for now) can be changed after the account is created.

  • Account name: Something like my-company-name. This will be part of your account's API hostname. This must be unique across all accounts.
  • Account display name: Anything you want, for easy reading on the Web Console.
  • Region: We currently support several regions in AWS. If you need a different region or cloud provider, please let us know.

To invite more people to an account add their email address(es) under Member Management, under Manage Account.

Once you have an account, you're ready to create and manage your Decodable resources using either the app or our CLI. Read on!

Install the CLI (Command Line Interface)

The simplest way to install the CLI is our simple install script. Just run this and you should be all set!

curl -L releases.decodable.co/install | bash

If you'd prefer to download and install the CLI manually, follow these steps:

First, download the CLI, verify the file SHA, and decompress it.

curl -O https://releases.decodable.co/decodable-cli/darwin/amd64/decodable-cli-darwin-amd64-<<cliVersion>>.tar.gz
curl -O https://releases.decodable.co/decodable-cli/darwin/amd64/decodable-cli-darwin-amd64-<<cliVersion>>.tar.gz.sha
shasum -a 256 -c decodable-cli-darwin-amd64-<<cliVersion>>.tar.gz.sha
tar -zxvf decodable-cli-darwin-amd64-<<cliVersion>>.tar.gz
curl -O https://releases.decodable.co/decodable-cli/darwin/arm64/decodable-cli-darwin-arm64-<<cliVersion>>.tar.gz
curl -O https://releases.decodable.co/decodable-cli/darwin/arm64/decodable-cli-darwin-arm64-<<cliVersion>>.tar.gz.sha
shasum -a 256 -c decodable-cli-darwin-arm64-<<cliVersion>>.tar.gz.sha
tar -zxvf decodable-cli-darwin-arm64-<<cliVersion>>.tar.gz
curl -O https://releases.decodable.co/decodable-cli/linux/amd64/decodable-cli-linux-amd64-<<cliVersion>>.tar.gz
curl -O https://releases.decodable.co/decodable-cli/linux/amd64/decodable-cli-linux-amd64-<<cliVersion>>.tar.gz.sha
shasum -a 256 -c decodable-cli-linux-amd64-<<cliVersion>>.tar.gz.sha
tar -zxvf decodable-cli-linux-amd64-<<cliVersion>>.tar.gz

You might want to move the CLI directory to an appropriate place on your system such as /usr/local or /opt, and add the bin directory to your shell's $PATH. Alternatively, you could copy the decodable executable to an existing location already in the shell's path.

Setup Your Decodable Environment

The CLI uses profiles stored in a configuration file to make API requests to Decodable. To set up this configuration file, use the decodable config setup command.

# <account> should be your decodable account name (e.g. my-account).
decodable config setup <account>
# Output:
#
# Generated file: /Users/esammer/.decodable/config

You only need to do this once: your CLI will use the settings in this config file from now on.

Login

Decodable supports authentication via a number of identity providers (IDPs) including enterprise SAML 2.0, OAuth2/OIDC, and social IDPs like Google, Github, and Microsoft. To login, run decodable login and follow the instructions to complete the login process.

decodable login

This command will prompt you for your Decodable account and step you through the authentication process with one of your account's configured IDPs. You'll be prompted to enter an authentication code to complete the authentication process.

In most cases, you only need to login once. The CLI stores credential information in ~/.decodable/auth and will automatically refresh credentials as necessary.

Using the CLI

Now that you're logged in, you're ready to get started using the Decodable CLI! Let's start by using the help option to see what we can do.

decodable help
# Usage:
#   decodable [command]
#
# Available Commands:
#   config      Manage client configuration
#   connection  Manage connections
#   help        Help about any command
#   login
#   pipeline    Manage pipelines
#   stream      Manage streams
#
# Flags:
#   -h, --help   help for decodable
#
# Use "decodable [command] --help" for more information about a command.

πŸ‘

Tip: CLI patterns

Almost all resource-related CLI commands - connection, stream, pipeline, etc. - use the same general subcommands of get, list, create, delete, and update with the same flags. Additionally, all commands always support --help!

From here, you're ready to work with an example, explore the CLI yourself or dive into the core concepts behind Decodable!


What’s Next

Learn about the core concepts.

Did this page help you?