1.0.3 • Published 4 years ago
@ellx/cli v1.0.3
Ellx CLI
Ellx CLI enables local development in Ellx. Simply run
ellx -u your-ellx-usernameto serve current working directory in Ellx. Select "Ellx CLI connect" in the Ellx user menu and input server identity value ("localhost~3002" by default) and that's it!
Installation
npm i -g @ellx/cli or yarn global add @ellx/cliOptions
| Option, alias | Default | Description |
|---|---|---|
--user, -u | required | Ellx username |
--port, -p | 3002 | Serve on this port |
--identity, -i | localhost~port | Local server instance identity (the value you should input in "Ellx CLI connect") |
--root, -r | cwd | Directory to serve |
Syncing with Github
Please refer to this section of Ellx docs on how to set up Github action to sync a repository and an Ellx project.
Server REST API
| Path | Parameters | Description |
|---|---|---|
GET /identity | retrieve the identity of the server (default: localhost-port) | |
GET /resource/:path | retrieve the resource (a file or a folder index) | |
POST /resource/:path | action (move/copy), destination | move or copy the resource |
DELETE /resource/:path | delete the resource | |
PUT /resource/:folderPath | files: [[path, contents]] | create or update multiple files or folders |