Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

SDK, dev docs images, SSH-over-Tor, Misc edits

Browse Source
This commit is contained in:
kn0wmad
2022-01-28 16:06:43 -07:00
committed by Lucy Cifferello
parent 9233b97424
commit b908e782e4
13 changed files with 131 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
site/source/support/dev-docs/dev-tools/embassy-sdk.rst
View File

@@ -6,47 +6,37 @@ Embassy-SDK
.. warning:: This is for developers only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
.. When interacting with Embassy directly, you will invariably want to use ``embassy-cli``. Embassy-CLI can control EmbassyOS in many of the same ways that the UI can, but with finer controls and deeper insights.
You can install to your system by running the following from you ``embassy-os`` directory:
.. In order to use Embassy-CLI, you will first need to authorize yourself with the following command...
.. code-block:: bash
.. .. code-block:: bash
.. embassy-cli auth login
.. and enter your Embassy Master Password at the prompt.
cargo install --bin=embassy-sdk --path=. --no-default-features --verbose
.. You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an overview of capabilities:
You can enter ``embassy-sdk help`` or ``embassy-sdk <option> help`` to get an overview of capabilities:
.. .. code-block:: bash
.. code-block:: bash
.. Embassy CLI
embassy-sdk --help
Embassy SDK
.. USAGE:
.. embassy-cli [OPTIONS] <SUBCOMMAND>
USAGE:
embassy-sdk [OPTIONS] <SUBCOMMAND>
.. FLAGS:
.. --help Prints help information
.. -V, --version Prints version information
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
.. OPTIONS:
.. -c, --config <config>
.. -h, --host <host>
.. -p, --proxy <proxy>
OPTIONS:
-c, --config <config>
.. SUBCOMMANDS:
.. auth Login/logout and manage sessions
.. backup Manage backups
.. db Interact with the Database
.. disk Information on the external drive
.. echo Echoes
.. git-info Print the current git hash
.. help Prints this message or the help of the given subcommand(s)
.. inspect Details on services and their components
.. net Network information
.. notification Control UI notifications
.. package Interact with packages
.. server EmbassyOS operations and information
.. ssh Manage SSH keys
.. wifi Manage WiFi networks
SUBCOMMANDS:
git-info Print current git hash
help Prints this message or the help of the given subcommand(s)
init Initialize
inspect Inspect a .s9pk
pack Package a service into the .s9pk format
verify Verify a .s9pk is valid
Please visit https://github.com/Start9Labs/embassy-os/tree/master/backend for more details