Skip to content

Commit

Permalink
deploy: bc8f5c1
Browse files Browse the repository at this point in the history
  • Loading branch information
ankitrgadiya committed Oct 22, 2024
0 parents commit aa16856
Show file tree
Hide file tree
Showing 75 changed files with 19,572 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
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 added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
cli.rapyuta.io
22 changes: 22 additions & 0 deletions _sources/apply.rst.txt
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
11 changes: 11 additions & 0 deletions _sources/auth.rst.txt
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

10 changes: 10 additions & 0 deletions _sources/chart.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/completion.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/config_tree.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/deployment.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/device.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/disk.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/hwil.rst.txt
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
99 changes: 99 additions & 0 deletions _sources/index.rst.txt
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`
10 changes: 10 additions & 0 deletions _sources/network.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/organization.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/package.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/parameter.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/project.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/rosbag.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/secret.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/static_route.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/usergroup.rst.txt
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
10 changes: 10 additions & 0 deletions _sources/vpn.rst.txt
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
Loading

0 comments on commit aa16856

Please sign in to comment.