knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #644 from datopian/update/cli-readme

Browse Source 
update cli app readme
This commit is contained in:
Rising Odegua 2022-02-02 23:51:00 -08:00 committed by GitHub
commit f2fe319e51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
bin/README.md
View File

@ -79,4 +79,20 @@ Why to deploy my data?
* Can integrate access control (?)
* Deploys a data API
* [Other integrations e.g. push to google spreadsheets]
* Dashboard showing your DataHub/Portal projects
* Dashboard showing your DataHub/Portal projects
### Extra supported commands
You can directly specify a folder to build from:
```bash
portal show path=\some\path\dataset
```
Optional args you can pass yo the show command are:
- path: The path to a dataset directory. If blank, defaults to current working directory
- port: The port number to display your dataset in. Defaults to 3000.
- npm: Whether or not to use npm when install packages. Defaults to `false`, uses yarn.
```
portal show [path=\some\path\dataset | port=4000 | npm=true]
```