2.3.1 • Published 1 year ago

@ezpaarse-project/ezmesure-admin v2.3.1

Weekly downloads
-
License
CeCILL
Repository
github
Last release
1 year ago

ezmesure-admin

Prerequisite

  • git >= 2.27.0
  • NodeJS >= 14.15.0
  • npm >= 6.14.8

Install

$ npm i -g @ezpaarse-project/ezmesure-admin

Usage

$ ezmesure-admin --help
$ ezadmin --help
$ eza --help

Global options

NameTypeDescription
-t, --timeoutStringRequest timeout in milliseconds
-v, --verboseBooleanMake the operation more talkative
--versionBooleanPrint the version number
--helpBooleanShow some help

Commands

NameDescription
clusterManage cluster
completionUse auto completion
configManage ezmesure-admin config
counter4 (deprecated)Load counter4 files in Kibana
counter5COUNTER5 commands
dashboardManage Kibana dashboards
indicesManager ezMESURE/Kibana users
index-patternManager ezMESURE/Kibana users
institutionsManage ezMESURE institutions
loginLogin user in commands
logoutLog out from ezMESURE
pingPing ElasticSearch and ezMESURE
profileDisplays the person who is connected to the command
reportingManage ezMESURE reporting
rolesManage Kibana roles
spacesManage Kibana spaces
sushiManage ezMESURE sushi
usersManage ezMESURE/Kibana users

Development

$ git clone https://github.com/ezpaarse-project/ezmesure-admin.git
$ cd ezmesure-admin
$ npm install

To use the command in development mode simply use it as follows: ./ezmesure-admin <command>

Tests

Set EZMESURE_ADMIN_USERNAME and EZMESURE_ADMIN_PASSWORD envrionment variables.

You need configure elastic and ezmesure config before use.

The user cannot be a reserved user (ex: elastic, ...). He must have superuser rights to perform the tests

It can be the default user created at the initialization of ezMESURE using the same environment variables.

$ npm run test

i18n

  1. In ezmesure-admin file, add your locale in locales array.
  2. Create your locale JSON file in locales folder.
  3. Import i18n in your commande file
  4. Use i18n.t() function to translate

Example :

Command file :

const { i18n } = global;

exports.command = 'mycmd';
exports.desc = i18n.t('mycmd.description');
exports.builder = {};
exports.handler = async function handler() {
  console.log(i18n.t('mycmd.helloWorld'))
};

Locale file :

{
  "mycmd": {
    "descritpion": "This is my command",
    "helloWorld": "Hello World"
  }
}

License

CeCILL.