Skip to content
This repository was archived by the owner on Jan 18, 2023. It is now read-only.

code-store-cli.md

Latest commit

 

History

History
90 lines (63 loc) · 2.75 KB

code-store-cli.md

File metadata and controls

90 lines (63 loc) · 2.75 KB
description code.store CLI provides a set of commands that allow you to manage your services and projects. This section contains the installation steps, a typical workflow and a description of main commands.

Getting started

Installation

{% hint style="success" %} We are iterating really fast in order to bring the best user experience and some great features to our product, that's why please check for updates in our CLI! {% endhint %}

macOS

brew tap code-store-platform/brew && brew install codestore

Other installation methods

NPM

This installation method is not recommended as it does not auto-update.

npm install -g codestore

Standalone tarballs

These are available in gzip compression:

Verifying the installation

To verify that the CLI has been correctly installed, use the codestore --version command:

codestore --version

You should see "codestore x.y.z darwin-X node-vX.Y.Z" output.

{% hint style="info" %} The CLI can be accessed through two commands: codestore or its shorter version cs {% endhint %}

Staying up to date

The code.store CLI will keep itself up to date automatically, unless you installed it via npm install. In that case use npm update codestore in order to upgrade the package to the latest version.

{% hint style="info" %} Most of the commands accept some specific arguments which can be provided while invoking the command in a long or short formats:

  • Long format: cs command --argumentName argumentValue
  • Short format: cs command -a argumentValue

Use cs help to know more about its commands and their arguments. {% endhint %}

Service directory structure

For each service, the code.store CLI is generating a directory structure that resembles the following:

# Example of the directory structure of a Service
./
├── src/
│		├── data/ # contains generated TypeORM entities
│		├── resolvers/
│		│		├── mutations/
│		│				└── mutationExample.js|ts
│		│		├── queries/
│		│				└── queryExample.js|ts
│		└── schema.graphql # GraphQL definition of your service's API
├── .build # temporary directory
├── package.json # standard NPM configuration file
└── codestore.yaml # main configuration file

Read more about the anatomy of the service directory here.