https://github.com/renderedtext/cli

Semaphore Classic Command Line Interface
https://github.com/renderedtext/cli

ci cli semaphore-ci semaphore-open-source

Last synced: 27 days ago
JSON representation

Semaphore Classic Command Line Interface

• Host: GitHub
• URL: https://github.com/renderedtext/cli
• Owner: renderedtext
• Created: 2017-07-14T08:36:26.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-05T14:25:53.000Z (about 6 years ago)
• Last Synced: 2024-04-24T20:42:09.436Z (8 months ago)
• Topics: ci, cli, semaphore-ci, semaphore-open-source
• Language: Ruby
• Homepage: https://semaphoreci.com
• Size: 449 KB
• Stars: 15
• Watchers: 12
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Semaphore Classic CLI

__Note:__ This is a CLI for Semaphore Classic. If you are looking for Semaphore 2.0 CLI, visit .

![Semaphore logo](https://d1dkupr86d302v.cloudfront.net/assets/application_bootstrap/layout/semaphore-logo-a6d954e176b6975b511f314a0cc808dc94a8030210077e3a6e904fbe69dc5354.svg)

[![Build Status](https://semaphoreci.com/api/v1/renderedtext/cli/branches/master/badge.svg)](https://semaphoreci.com/renderedtext/cli)

[![Gem Version](https://badge.fury.io/rb/sem.svg)](https://badge.fury.io/rb/sem)

The Semaphore Classic CLI is used to manage Semaphore projects from the command line.

For more info about Semaphore see 

## Usage

First, install the gem on your local machine:

``` bash

$ gem install sem

```

Login to Semaphore:

``` bash

$ sem login --auth-token 

```

Display the help screen:

``` txt

$ sem help

Usage: sem [command]

Command list, type sem help [command] for more details:

  version         Check cli version

  login           Log in to semaphore from the command line

  logout          Log out from semaphore

  orgs            Manage organizations

  teams           Manage teams and team membership

  shared-configs  Manage shared configurations

  projects        Manage projects

```

## Issues

For problems directly related to the CLI, [add an issue on GitHub](https://github.com/renderedtext/cli/issues/new).

For other issues, [submit a support ticket](https://semaphoreci.com/support).

[Contributors](https://github.com/renderedtext/cli/contributors).

## Development

Developing the CLI locally requires Ruby >= 2.0. While developing please follow

the [CLI development guide](guides.md).

To run the CLI locally, use the `bundle exec sem`.

#### Generating Docs

First, generate a JSON structure of the CLI, by running:

``` bash

./bin/generate_json_structure

```

Use that structure to generate docs in the semaphore-docs-new repository.

#### Semaphore Resource Name (SRN)

SRN is a way of identifying Semaphore resources. This CLI uses SRNs as arguments

for all actions.

Formats for individual resources are the following:

- Organization: `organization_name`

- Team: `organization_name/team_name`

- Project: `organization_name/project_name`

- Shared Configuration: `organization_name/shared_configuration_name`

#### Using custom API URL

Create a file at `~/.sem/api_url` containing only the custom url.