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

https://github.com/dadi/cli

DADI CLI is a command-line tool to help with the installation and customisation of the various services within the DADI platform
https://github.com/dadi/cli

Last synced: about 1 year ago
JSON representation

DADI CLI is a command-line tool to help with the installation and customisation of the various services within the DADI platform

Awesome Lists containing this project

README

          

DADI CLI logo

[![npm (scoped)](https://img.shields.io/npm/v/@dadi/cli.svg?maxAge=10800&style=flat-square)](https://www.npmjs.com/package/@dadi/cli)
[![Coverage Status](https://coveralls.io/repos/github/dadi/cli/badge.svg?branch=master)](https://coveralls.io/github/dadi/cli?branch=master)
[![Build Status](https://travis-ci.org/dadi/cli.svg?branch=master)](https://travis-ci.org/dadi/cli)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

# DADI CLI

## Overview

DADI CLI is a command-line tool to help with the installation and customisation of the various products of the DADI platform.

## Usage

Commands always start with `npx dadi-cli `, taking different parameters and flags depending on the operation.

The command `npx dadi-cli help` shows a list of all the available commands for the various products, whilst `npx dadi-cli help ` and `npx dadi-cli help ` provides detailed information about a product and a command, respectively.

## Links

- [CLI Documentation](https://docs.dadi.cloud/cli/)

## Development

To get started, run:

```shell
# Install dependencies
npm install

# Run the `npx dadi-cli help` command
node index.js help
```

By default, CLI will communicate with the live registry server at https://registry.dadi.tech. When developing, you might want to use your own local registry, in case you want to test assets that are not yet available on live.

To do this, grab a copy of the [registry repository](https://github.com/dadi/registry), start a local server, and tell CLI the URL of the registry to use.

```shell
# If your registry server is available at http://localhost:7100
REGISTRY_URL="http://localhost:7100" node index.js help
```

## Licence

DADI is a data centric development and delivery stack, built specifically in support of the principles of API first and COPE.

Copyright notice

(C) 2019 DADI+ Limited

All rights reserved

This product is part of DADI.

DADI is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version ("the GPL").

**If you wish to use DADI outside the scope of the GPL, please
contact us at info@dadi.co for details of alternative licence
arrangements.**

**This product may be distributed alongside other components
available under different licences (which may not be GPL). See
those components themselves, or the documentation accompanying
them, to determine what licences are applicable.**

DADI is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

The GNU General Public License (GPL) is available at
http://www.gnu.org/licenses/gpl-3.0.en.html.

A copy can be found in the file GPL.md distributed with
these files.

This copyright notice MUST APPEAR in all copies of the product!