diff --git a/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst b/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst index 45f9dd0..448c841 100644 --- a/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst +++ b/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst @@ -1,43 +1,114 @@ .. _embassy-sdk: -================================ -Embassy Software Development Kit -================================ +=========== +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. +The embassyOS embedded Software Development Kit (SDK), is a CLI (Command Line Interface) tool that aids in building and packaging services you wish to deploy to the Embassy. -You can install to your system by running the following from your ``embassy-os`` directory: +It helps validate that the necessary components of the package exist, and package all of those components into a special file type (``s9pk``) that is understood by embassyOS. - .. code-block:: bash +Installation +============ - cd backend - ./install-sdk.sh +You can install this component on any system, without needing to run embassyOS, by running the following command: + + .. code-block:: + + git clone -b latest --recursive https://github.com/Start9Labs/embassy-os.git && cd embassy-os/backend && ./install-sdk.sh + + +Next, initialize the SDK and verify the installation was successful: + + .. code-block:: + + embassy-sdk init + embassy-sdk --version -You can enter ``embassy-sdk help`` or ``embassy-sdk