https://github.com/restorando/samson-cli

https://github.com/restorando/samson-cli

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/restorando/samson-cli
• Owner: restorando
• Created: 2017-01-05T17:32:54.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-12-27T14:42:57.000Z (almost 5 years ago)
• Last Synced: 2024-10-10T19:07:18.238Z (2 months ago)
• Language: JavaScript
• Size: 929 KB
• Stars: 5
• Watchers: 20
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Samson CLI

Command line utility to manage deploys in Zendesk's Samson



## Requirements

`git` and Node.js >=4 with `npm`.

## How to install

Just install the `samson-cli` globally.

```

npm install -g samson-cli

```

## Configuration

You should create a `samsonrc.json` file in each of your project directories. `samson` will look for it when you run the tool. The file should have this shape:

```json

{

  "url": "http://my-samson-url.com",

  "project": "myProjectName",

  "auth": "",

  "samson": {

    "production": true

  }

}

```

The `auth` key expects the value of your Samson session cookie. We still don't have a better authentication system (perhaps based in a Samson user token) due to Samson API limitations.

## Usage

```

samson  [options...]

```

## Commands

### `deploy`

Performs a deploy of a branch or tag to a stage.

Syntax:

```

samson deploy  

```

Where `stage` is a valid stage (see `samson stages`) and `reference` is a branch, tag or commit SHA.

Example:

```

samson deploy staging master

```

### `deploys`

Prints the last 15 deploys.

Syntax:

```

samson deploys

```

### `builds`

Prints the last builds.

Syntax:

```

samson builds

```

### `stages`

Prints the configured stages.

Syntax:

```

samson stages

```

## Options

### `-c | --config`

You can specify a custom config, in json format

Syntax:

```

samson  -c '{ "url": "http://my-samson-url.com", ...}'

```

Note: You may not need to have a `samsonrc.json` file in order to use the program if the config is specified this way, but some autocompletion features will be disabled

## To do

- [ ] Authenticate using Samson token instead of the session cookie

- [ ] Better help and readme

- [ ] Show deploy output

- [ ] Be able to specify a custom `samsonrc.json`

- [ ] Fail when no `samsonrc.json` is found

- [ ] Manage configuration defaults