Home

---

Skelebot API

Version 1

---

Purpose

Skelebot exposes a number of functions that can be called inside of a plugin in order to execute and leverage important parts of the Skelebot System.

This document specifies the API contract for v1 of Skelebot.

There are packages and classes outside of this API that are technically accessible via Skelebot, but since they are not included in this specification, they are not part of the v1 contract for Skelebot. As such it is not advised to use any function or Class that is not specified in this document because it may be subject to change throughout iterations of v1.

---

APIs

• Common
• Objects
  • Component – The base object for Plugins to allow them to hook into the Skelebot Systems
  • SkeleYaml – The base object for any config Class that needs to be marshalled to/from YAML
• Execution
  • Docker – The Docker execution functions for building images and running containers
• Generators
  • YAML – The YAML generator for saving and loading config from skelebot.yaml
  • Dockerfile – The Dockerfile generator for constructing the project Dockerfile
  • Dockerignore – The dockerignore generator for constructing the project .dockerignore
• Scaffolding
  • Prompt – The function used to present prompts to the user for scaffolding purposes

---

Updates

v1.1.0 Additions

• SkeleYaml
  • schema (attribute)
  • loadList (method)
  • validate (method)

---

<< Timezone | Home >>