JEC GlassCat Commands Project
The GlassCat Commands Project contains the default commands used by the GlassCat Command Line Interface to manage utilities.
Requirements
The JEC GlassCat Commands Project needs the following system parameters in order to work correctly:
- Node 6+
- npm 3+
- TypeScript 2+
Installation
Set up the JEC GlassCat Commands module with:
$ npm install jec-glasscat-commands --save
Running Tests
To execute all unit tests, use:
$ npm test
API Reference
The API Reference documentation is not included into the JEC GlassCat Commands node module. To build the API reference documentation, use:
$ grunt doc
Documentation will be generated in the docs/api-reference
repository.
The online version of the API reference documentation will be available soon at the JEC Website.
The documentation generator is TypeDoc
Update Release Notes
Current stable release: 1.0.6
For a complete listing of release notes for all JEC GlassCat Commands update releases, see the CHANGELOG file.
License
This JEC GlassCat Commands Project is licensed under Apache 2.0. Full license text is available in LICENSE.
Copyright 2016-2018 Pascal ECHEMANN.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.