README.md

nervproj

NervProj is a "Project management" layer that can be used to manage the workflow on other sub-projects

Initial setup:

First checkout the repository:

# For project members:
$ git clone [email protected]:roche-emmanuel/nervproj.git NervProj

# For non-project members:
$ git clone https://github.com/roche-emmanuel/nervproj.git NervProj

Next setup the CLI:

$ cd NervProj
$ ./cli.sh admin install cli

Available commands

Checking out repositories

• To checkout a given project repository into a specific path:

$ nvp -p nvh git clone D:/Projects/NervHome

• Then we can init the project with a default git setup:

$ nvp -p nvh admin init

• To checkout an arbitrary repository given by path into a specific path :

$ nvp git clone -u [email protected]:roche-emmanuel/sift.git D:/Projects/sift

Building libraries

• Force rebuilding a given library:

$ nvp build libs llvm --rebuild

• Building multiple libraries at once:

$ nvp build libs libiconv,zlib,libxml2

• Previewing the sources for a given library without actually building/rebuilding it:

$ nvp build libs libxml2 --preview

Sending rocketchat messages:

• Example of sending a rocketchat message to a given server:

$ nvp rchat "Hello from nvp command"

• Required rocketchat configuration elements (in the global nervproj config file, inside the rocketchat entry):
  • base_url: URL of the server, for instance "http://192.168.0.20:3000"
  • default_channel: Default channel where the message should go, for instance "global-admin"
  • user_id: User Id from the rocketchat personnal access token generated for from an existing account (should have 2FA disabled)
  • token: Token from the rocketchat personnal access token generated for from an existing account (should have 2FA disabled)

Sending emails:

• Example of sending an email with a configured SMTP server:

$ nvp email "This is the email body, can use <b>html code</b>" -t "This is the email title"

• Required configuration elements are specified in the email config entry:

  "email": {
    "smtp_server": "192.168.0.20:587",
    "default_username": "[email protected]",
    "default_password": "xxxxxxxxx",
    "default_to_addrs": "[email protected]",
    "default_from_addr": "[email protected]"
  }