https://github.com/ardier16/shelf-cli

Shelf.Network CLI
https://github.com/ardier16/shelf-cli

api cli gitlab jira slack typescript

Last synced: 2 days ago
JSON representation

Shelf.Network CLI

• Host: GitHub
• URL: https://github.com/ardier16/shelf-cli
• Owner: ardier16
• License: mit
• Created: 2021-10-15T21:26:54.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-22T19:53:22.000Z (about 3 years ago)
• Last Synced: 2024-11-13T08:57:18.479Z (5 days ago)
• Topics: api, cli, gitlab, jira, slack, typescript
• Language: TypeScript
• Homepage:
• Size: 379 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# 🚀 Shelf.Network CLI

CLI tools designed specially for Shelf.Network members. Gitlab, Jira & Slack integration provided.

## 🛠 Installation

```bash

yarn global add @ardier16/shelf-cli

```

or

```bash

npm i -g @ardier16/shelf-cli

```

Then initialize CLI by running:

```bash

shelf init

```

## 💻 Usage 

CLI contains commands for easier integration with Gitlab, Jira & Slack.

### ⚙️ Commands

|      | Command           | Description  

| ---- | ----------------- | ---------------

| ✅   | `init`            | Initializes CLI with third-party services

| ✅   | `push-mr`         | Create new branch and related merge request on Gitlab

| ✅   | `slack-mr`        | Remove WIP badge and send merge request message to Slack

| ✅   | `clone`           | Search and clone Gitlab project

| ✅   | `log-work`        | Add worklog for current task to Jira

| ✅   | `today-worklog`   | Get today's total worklog for current user

| 🧑‍💻   | `merge-requests`  | Get user's open merge requests list

| 🧑‍💻   | `issues`          | Get user's issues

### 😎 Cool things

- ✅ TypeScript

- ✅ Shelf.Network logo

- ✅ [NPM package](https://www.npmjs.com/package/@ardier16/shelf-cli)

- 🧑‍💻 Terminal autocomplete

  - ✅ zsh

  - 🧑‍💻 bash

- 🧑‍💻 Extended help

- 🧑‍💻 Github actions

- 🧑‍💻 VS Code launch file

## Running locally

You should have Node.js 12+ and Yarn installed globally.

### Install dependencies 

```bash

yarn

```

### Run in watch mode 

```bash

yarn start

```

### Build lib

```bash

yarn build

```

### Run linter

```bash

yarn lint

```