-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit aa16856
Showing
75 changed files
with
19,572 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 6093010f34ef7c1d78640b5f9744704f | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
cli.rapyuta.io |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Apply | ||
===== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.apply:apply | ||
:prog: rio apply | ||
:nested: full | ||
|
||
.. click:: riocli.apply:delete | ||
:prog: rio delete | ||
:nested: full | ||
|
||
.. click:: riocli.apply:template | ||
:prog: rio template | ||
:nested: full | ||
|
||
.. click:: riocli.apply:explain | ||
:prog: rio explain | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Authentication | ||
============== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.auth:auth | ||
:prog: rio auth | ||
:nested: full | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Chart | ||
===== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.chart:chart | ||
:prog: rio chart | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Completion | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.completion:completion | ||
:prog: rio completion | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Config Trees | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.configtree:config_trees | ||
:prog: rio configtree | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Deployment | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.deployment:deployment | ||
:prog: rio deployment | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Device | ||
====== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.device:device | ||
:prog: rio device | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Disk | ||
==== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.disk:disk | ||
:prog: rio disk | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Hardware-in-Loop | ||
================ | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.hwil:hwildevice | ||
:prog: rio hwil | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
Welcome to rapyuta.io CLI documentation! | ||
======================================== | ||
|
||
The rapyuta.io CLI (aka riocli) exposes features of Rapyuta.io platform on the command-line. | ||
|
||
The application is written in Python 3 and it is distributed through PyPI for | ||
Python 3 environments. | ||
|
||
Installation | ||
-------------- | ||
|
||
Installing the ``AppImage`` | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
You can install the latest ``AppImage`` on your Linux systems using the following command. | ||
|
||
.. code:: bash | ||
curl -fSsL https://cli.rapyuta.io/install.sh | bash | ||
Installing via ``pip`` | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Alternatively, you can install the CLI using ``pip``. | ||
|
||
.. code:: bash | ||
pip install rapyuta-io-cli | ||
On Unix-like systems it places the ``rio`` executable in the user's PATH. On | ||
Windows it places the ``rio.exe`` in the centralized ``Scripts`` directory which | ||
should be in the user's PATH. | ||
|
||
Installing from source | ||
~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
To install the CLI from source, you can use the ``setup.py`` script directly. | ||
Clone the repository and from the root of the directory, run the following | ||
command. | ||
|
||
.. code:: bash | ||
git clone [email protected]:rapyuta-robotics/rapyuta-io-cli.git | ||
cd rapyuta-io-cli | ||
python setup.py install | ||
Getting Started | ||
--------------- | ||
|
||
To begin using the CLI, it must be authenticated with rapyuta.io. | ||
|
||
.. code:: bash | ||
rio auth login | ||
The ``email`` and ``password`` can either be given through flags (for scripting | ||
purposes) or interactively through the Prompts. | ||
|
||
.. note:: | ||
|
||
Entering ``password`` as a flag is not recommended because it leaves the traces. | ||
|
||
Commands | ||
-------- | ||
|
||
Rapyuta CLI has commands for all rapyuta.io resources. You can read more about the sub-commands on there pages: | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
Apply <apply> | ||
Authentication <auth> | ||
Chart <chart> | ||
Completion <completion> | ||
ConfigTree <config_tree> | ||
Deployment <deployment> | ||
Device <device> | ||
Disk <disk> | ||
Hardware-in-Loop <hwil> | ||
Network <network> | ||
Organization <organization> | ||
Package <package> | ||
Parameter <parameter> | ||
Project <project> | ||
Rosbag <rosbag> | ||
Secret <secret> | ||
Static Route <static_route> | ||
User Group <usergroup> | ||
VPN <vpn> | ||
|
||
|
||
|
||
Indices and tables | ||
================== | ||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Network | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.network:network | ||
:prog: rio network | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Organization | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.organization:organization | ||
:prog: rio organization | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Package | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.package:package | ||
:prog: rio package | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Parameter | ||
========= | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.parameter:parameter | ||
:prog: rio parameter | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Project | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.project:project | ||
:prog: rio project | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Rosbag | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.rosbag:rosbag | ||
:prog: rio rosbag | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Secret | ||
====== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.secret:secret | ||
:prog: rio secret | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Static Route | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.static_route:static_route | ||
:prog: rio static-route | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
User Group | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.usergroup:usergroup | ||
:prog: rio usergroup | ||
:nested: full |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
VPN | ||
====== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:caption: Contents: | ||
|
||
.. click:: riocli.vpn:vpn | ||
:prog: rio vpn | ||
:nested: full |
Oops, something went wrong.