Project

sem

0.01
No commit activity in last 3 years
No release in over 3 years
Semaphore CLI
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.14
~> 9.0.0
~> 10.0
~> 3.0
~> 0.49.0
~> 0.13
~> 3.0.1

Runtime

~> 0.6.0
~> 1.1.1
 Project Readme

Semaphore Classic CLI

Note: This is a CLI for Semaphore Classic. If you are looking for Semaphore 2.0 CLI, visit https://github.com/semaphoreci/cli.

Semaphore logo

Build Status Gem Version

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

For more info about Semaphore see https://semaphoreci.com

Usage

First, install the gem on your local machine:

$ gem install sem

Login to Semaphore:

$ sem login --auth-token <your-auth-token>

Display the help screen:

$ 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.

For other issues, submit a support ticket.

Contributors.

Development

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

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

Generating Docs

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

./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.