npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

api-console-cli

v3.0.0

Published

A set of dev tools for API console

Downloads

228

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

jarrodekjarrodekmulesoft-npmmulesoft-npm

Keywords

API Consoletoolsbuilder

Readme

API console CLI

The command-line tool for the MuleSoft API Console.

Features

  • build - Build the API Console application optimized for production
  • generate-json - (Re)generates the JSON file that is accepted as console's data model
  • serve - Test generated bundle in local environment.

Installation

npm i -g api-console-cli

In macOS and Linux you may need to use sudo prefix.

Compatibility

This version does not work with API console version 4 and 5.

This CLI tool works with version 6 only.

Please, use other versions of the CLI for previous versions of the console. Note, that previous versions of API Console are not longer supported. Please, see API Console Docs for latest release documentation.

npm install -g [email protected]

Command Overview

CLI --help is your friend. Run any command with --help option to see list of available options.

General options

api-console [COMMAND] --help

Run api-console --help to get a list of supported commands. Pass it a command name (ex: api-console build --help) to get detailed information about that command and the options it supports.

Commands

api-console build -t TYPE [options] FILE

Builds the API Console for specific API definition. The build is optimized for production.

api-console generate-json -t TYPE [options] FILE

Creates a JSON file from the RAML or OAS spec that can be used as a data source for the API Console.

api-console serve [options] [PATH]

Runs a local web server serving a content of the current directory or selected path.

Supported APIs

API Console consumes AMF data model generated from one of the following specifications:

  • RAML 1.0
  • RAML 0.8
  • OAS 2.0
  • OAS 3.0 - Experimental support. There might be some issues.

API support is not covered by nighter this CLI tool, building module, or API Console. This is provided by the AMF parser.

Contribution

Your feedback is welcome. If you need support for a method, command options other than described here please, file a feature request. If you find a bug, please, file a bug report with details so we can fix it.