https://github.com/SenseNet/sn-client-cli

Command line tool for the sensenet ECM's Client Library
https://github.com/SenseNet/sn-client-cli

ecms sensenet sn-client-js

Last synced: 9 months ago
JSON representation

Command line tool for the sensenet ECM's Client Library

• Host: GitHub
• URL: https://github.com/SenseNet/sn-client-cli
• Owner: SenseNet
• License: gpl-2.0
• Archived: true
• Created: 2017-04-03T07:25:57.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-12-10T07:00:56.000Z (about 7 years ago)
• Last Synced: 2025-04-14T20:18:34.491Z (10 months ago)
• Topics: ecms, sensenet, sn-client-js
• Language: TypeScript
• Homepage: https://www.sensenet.com/
• Size: 188 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# sn-client-cli

------

### This package is not under active development. You can find our latest packages in the [sensenset/sn-client](https://github.com/sensenet/sn-client) monorepo.

------

[![Gitter chat](https://img.shields.io/gitter/room/SenseNet/SN7ClientAPI.svg?style=flat)](https://gitter.im/SenseNet/SN7ClientAPI)

[![Build Status](https://travis-ci.org/SenseNet/sn-client-cli.svg?branch=master)](https://travis-ci.org/SenseNet/sn-client-cli)

[![codecov](https://codecov.io/gh/SenseNet/sn-client-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/SenseNet/sn-client-cli) 

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e3f64e9f929d4dbead466ba1283cf43b)](https://www.codacy.com/app/SenseNet/sn-client-cli?utm_source=github.com&utm_medium=referral&utm_content=SenseNet/sn-client-cli&utm_campaign=Badge_Grade)

[![NPM version](https://img.shields.io/npm/v/sn-client-cli.svg?style=flat)](https://www.npmjs.com/package/sn-client-cli)

[![NPM downloads](https://img.shields.io/npm/dt/sn-client-cli.svg?style=flat)](https://www.npmjs.com/package/sn-client-cli)

[![License](https://img.shields.io/github/license/SenseNet/sn-client-cli.svg?style=flat)](https://github.com/SenseNet/sn-client-cli/LICENSE.txt)

[![Greenkeeper badge](https://badges.greenkeeper.io/SenseNet/sn-client-cli.svg)](https://greenkeeper.io/)

This package is a command line tool for the sensenet ECM's [Client Library](https://github.com/SenseNet/sn-client-js "sn-client-js").

## Note

This package is under development and not released yet.

## Installation

### Prerequisites

* [Node.JS](https://nodejs.org) ^6.1.0

* [NPM](https://www.npmjs.com) ^4.0.0

* [NYC](https://www.npmjs.com/package/nyc) for running tests

You can install the latest version with NPM into your project dependencies

```shell

$ npm install sn-client-cli --save

```

Or you can install it globaly

```shell

$ npm install sn-client-cli -g

```

## Usage

From the command line you can run from the project directory

```shell

 $ .\node_modules\.bin\sn-client [command] --[options]

```

or from the global installation

```shell

$ sn-client [command] --[options]

```

### Available commands

**init** -

Creates an initial 'sn.config.js' in your project root. You can use this providing default configuration options to the CLI.

**fetch-types** - 

If you have customized your **sensenet ECM repository** with custom content types, you can use this command to get the generated TypeScript classes and refresh the built-in ones in **sn-client-js** package from a _specified_ repository.

**help** - Displays a help screen about the CLI with the available commands and options