apistash.io

Manage your specifications on the command line.

This is a tool to manage your specifications (OAS, GRPC, graphQL, trpc,....) from the command line. Use it while your developing a app or in your CI/CD to integrate APIs from another peer.

Index

• Description
• Why apistash ?
• Installation
  • Package manager
  • Releases
  • Build
• Getting started
  • Create token
  • Upload specification
  • Download specification
• Documentation
• Contribution
• License

Description

A command line tool to interaction with the platform.
Download your specifications while managing your dependencies or uploading
your specifications while working with CI/CD.

It doesn't matter if your specification is GRPC, OAS, graphQL or even trpc:
We got you covered.

If you want to hear more about our missing take a look at our website

Why apistash ?

Even if there are several services already there, they lack an important part of api communication: "The only thing that is constant is change." ~ Heraclitus

Often you have to deal with different kind of apis and technics.
apistash provides a management where it doesn't matter what kind of specification you have. Create a client from a grapQL schema, OAS or trpc types. Focus on your business instead of the one of others.

Installation

You have several options to install the command line tools

Package manager

Install the command line tool with a package manager like npm, yarn, ...

yarn install -D @apistash/cli

Releases

Download an executable of a release specific to your needs. The following operating systems and architectures are supported:

• linux (arm64, x64)
• macos (x64)
• win (x64)

Go to the releases page for further information

Build

Requirements

• node16

1. To build your client on your own clone the repository.

2. Install your dependencies

   yarn

3. Update types from apistash

   yarn update:types

4. Compile the code

   yarn build

5. Bundle the code into executable

   yarn package

Getting started

To get started install the command line tool via package-manager, executable or build on your own. It is required to create an access token for interaction with the api. In the next steps we will show you where to create it.

Create token

A token can be created on the platform at api-keys. Keep the token secret, otherwise you risk that someone can interact in your name. Use the token afterwards in the next commands.

Upload specification

To upload a specification you can type the following:

apistash-cli upload /path/to/file \
    --apiName "Example Api" \
    --semver "1.0.0" \
    --token TOKEN 

Download specification

To download a specification you can type the following:

apistash-cli download \
    --apiName "Example Api"
    -s 0.0.1
    --token TOKEN
    [--outputPath /path/to/output]
    [--outputName filename]

Documentation

The documentation is hosted on the website under Documentation .

Contribution

Contribution is welcome, create a PR while respecting the contribution guidelines.

Changelog

Changelog can be found at changelog.

License

MIT