You can find Agave applications (“apps”) in the Designsafe catalog by using the apps-list command described previously. What if the app you are looking for is not available? Using the Agave CLI, you can create your own.


Components of an app

The essential components you need to create your own app are:

  1. A Docker image containing the executable and all runtime dependencies
  2. A wrapper script (generally written in bash) that runs the executable
  3. A test script (also written in bash) for testing the executable outside of the Agave environment

Several example apps exist and all components are visible. For example, visit the Designsafe Docker hub to view existing app containers. And, example app bundles can be viewed on the Designsafe github page.


Create your own by example

The best way to demonstrate the creation of a custom app is by example. The following sub-pages will go through the process:

  1. Clone an example app
  2. Containerize your executable
  3. Build wrapper and test scripts
  4. Add your app to the Designsafe tenant
  5. Next steps

Return to the API Documentation Overview