Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/asyncapi/cli

CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!
https://github.com/asyncapi/cli

cli docker get-global-docs-autoupdate get-global-node-release-workflows get-global-releaserc hacktoberfest nodejs typescript

Last synced: about 2 months ago
JSON representation

CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!

Host: GitHub
URL: https://github.com/asyncapi/cli
Owner: asyncapi
License: apache-2.0
Created: 2021-02-16T09:05:02.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-04-15T11:56:08.000Z (5 months ago)
Last Synced: 2024-04-15T12:07:58.793Z (5 months ago)
Topics: cli, docker, get-global-docs-autoupdate, get-global-node-release-workflows, get-global-releaserc, hacktoberfest, nodejs, typescript
Language: TypeScript
Homepage: https://www.asyncapi.com/tools/cli
Size: 21.5 MB
Stars: 167
Watchers: 12
Forks: 129
Open Issues: 55
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        [![AsyncAPI CLI](./assets/logo.png)](https://www.asyncapi.com/tools/cli)

CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features. 

[![GitHub license](https://img.shields.io/github/license/asyncapi/cli)](https://github.com/asyncapi/cli/blob/master/LICENSE)

[![PR testing - if Node project](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml/badge.svg)](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml)

[![npm](https://img.shields.io/npm/dw/@asyncapi/cli)](https://www.npmjs.com/package/@asyncapi/cli)

## Table of contents

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

  * [Set up development environment](#set-up-development-environment)

  * [Command Structure and Patterns](#command-structure-and-patterns)

- [Contributors](#contributors)

## Installation

Learn how to install the AsyncAPI CLI by following the instructions in the [installation guide](/docs/installation.md). 

## Usage

The [usage guide](/docs/usage.md) provides information about different ways to use the CLI.

## Contributing

Read [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.

### Set up development environment

Follow these steps:

- Clone the repo.

- Run `npm install` to install all the required dependencies

- Run `npm run test` to make sure everything is properly set up

- Run `npm run build` and then `bin/run` to try new CLI locally

The UX developed for the CLI should comply with the [Command Line Interface Guideline](https://clig.dev/)

### Command Structure and Patterns

We are following `verb + noun` and `namespace + noun + [verb]` pattern for making our commands and arguments. For example `asyncapi validate ` and `asyncapi config context add  `.

## Contributors

Thanks go to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_{Jorge Aguiar Martín}
💻 🤔 ⚠️ 📖

      
_{Lukasz Gornicki}
🤔 💻 👀 🚧

      
_souvik
💻 🤔 ⚠️ 👀 🚧 📖

      
_{David Boyne}
💻 🤔 🚧

      
_{Fran Méndez}
💻 🤔 👀

      
_{Maciej Urbańczyk}
👀 🚧 🤔

      
_{Aayush Kumar Sahu}
💻 ⚠️

    

    

      
_{Mihir Kulkarni}
💻

      
_Abir
⚠️ 💻

      
_{Peter Ramos}
💻

      
_Samriddhi
⚠️

      
_{Pranay Kharabe}
💻

      
_{Damilola Oladele}
📖

      
_{Abhay Garg}
💻 ⚠️

    

    

      
_{Sambhav Gupta}
💻 ⚠️

      
_{Hippolyte Vergnol}
💻 🚇

      
_{Jente Vets}
💻

      
_Rishi
💻

      
_{Ashish Padhy}
💻

      
_{Meet Agrawal}
🚇

      
_{Chinmay Shewale}
💻 ⚠️

    

    

      
_{Mahfuza Humayra Mohona}
📖

      
_{Heiko Henning}
💻

      
_{Zack_Aayush}
💻

      
_{Ayush Nautiyal}
💻

      
_AnishKacham
💻

      
_{Viacheslav Turovskyi}
💻

      
_{Amanpreet Singh Bedi}
💻

    

    

      
_{Debajyoti Halder}
💻

      
_{Savio Dias}
💻

      
_{Jonas Lagoni}
💻 🤔 👀 ⚠️

      
_{Khuda Dad Nomani}
💻 📖

      
_{Sergio Moya}
💻

      
_{Vishal Sharma}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!