Skip to content

tredly/tredly-cli

Repository files navigation

Tredly CLI

Version 1.0.0 July 7 2016

This is a software package to provide remote access to Tredly Host. You can find out more information about Tredly at http://tredly.com

Installation

Requires tredly-api 0.4.0 https://github.com/tredly/tredly-api to be installed remotely on Tredly Host

Install Tredly CLI:

  1. Install Node.js
  2. Install npm
  3. Run sudo npm link

Usage

Tredly CLI is remote access command line client for tredly-api 0.4.0 https://github.com/tredly/tredly-api. You can find out more information about tredly commands at Tredly Documentation

It also provides additional commands for remote access:

  • tredly connect - use this command to connect to remote Tredly Host.
  • tredly disconnect - use this command to disconnect from remote Tredly Host.
  • tredly change password - use this command to change current user's password.
  • tredly push files --location=[server path] - use this command from source directory to push its contents to remote Tredly Host. This command does NOT create/update container.
  • tredly push container - use this command from your project directory (which contains tredly.yaml) to push the project to remote Tredly Host and create/update container. The command accept the same parameters as tredly create container. See Tredly Documentation

Administrator can also use the following commands:

  • tredly create user --username=[username] --password=[password] --admin=[true/false] --partitions=[partition1,partition2] - use this command to create a new user.
  • tredly edit user --username=[username] --password=[password] --admin=[true/false] --partitions=[partition1,partition2] - use this command to edit existing user.
  • tredly remove user --username=[username] - use this command to remove existing user.
  • tredly list users - use this command to list all users.

Contributing

We encourage you to contribute to Tredly. Please check out the Contributing documentation for guidelines about how to get involved.

License

Tredly is released under the MIT License.