Bladeren bron

[docs] First cli docs

Still very young but the skeleton is there.
Romain Rigaux 4 jaren geleden
bovenliggende
commit
4580e4ab4f

+ 1 - 1
docs/docs-site/content/developer/api/_index.md

@@ -4,6 +4,6 @@ draft: false
 weight: 4
 ---
 
-Interact with the API via [REST](/developer/api/rest/) or [Python](/developer/api/python/).
+Interact with the API via [REST](/developer/api/rest/), [Python](/developer/api/python/) or the [CLI](/developer/api/cli/).
 
 The JavaScript API from the [NPM package](/developer/components/) is not documented yet.

+ 32 - 0
docs/docs-site/content/developer/api/cli/_index.md

@@ -0,0 +1,32 @@
+---
+title: "CLI"
+date: 2020-09-08T00:00:00-07:00
+draft: false
+weight: 2
+---
+
+A wrapper around the REST API.
+
+Install:
+
+    pip install gethue
+
+And use:
+
+    > compose --help
+
+    > compose auth
+
+    Api url [https://demo.gethue.com]:
+    Username [demo]:
+    Password [demo]:
+    Auth: success 200
+    Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjMxMjE5MDkxLCJqdGkiOiJkNGJkY2Q5M2NjMjg0MDlkYWJlYWZhNGRlNjlkOTMzMyIsInVzZXJfaWQiOjJ9.Gr8bW_JaZ8yzQ3eEZYp3jKbdsSgLAXxqvSRbeU6jhLg
+
+    > compose query
+
+    > compose query autocomplete
+
+List, view, download, upload files:
+
+    compose storage list s3a://demo-gethue

+ 1 - 1
docs/docs-site/content/developer/api/python/_index.md

@@ -2,7 +2,7 @@
 title: "Python"
 date: 2019-03-13T18:28:09-07:00
 draft: false
-weight: 2
+weight: 3
 ---
 
 Leverage the built-in Python shell to interact with the server and the API.

+ 5 - 1
docs/docs-site/content/developer/development/_index.md

@@ -740,7 +740,7 @@ Draft a new release on https://github.com/cloudera/hue/releases.
 
 Publish Github NPM package and Docker images at https://github.com/orgs/cloudera/packages?repo_name=hue.
 
-### Gethue
+### Tarball
 
 Building the tarball release:
 
@@ -794,6 +794,10 @@ Then connect to the server and index the package:
     cd /var/www/helm.gethue.com
     helm repo index .
 
+### Pypi
+
+TBD
+
 ### Documentation
 
 Documentation is currently being auto refreshed every morning of the week and run as a container.