saagie / sdk

Saagie 📦 SDK for Technologies

Saagie 📦 SDK for Technologies

The Saagie Technology SDK allows you to implements new technologies easily within the Saagie platform.

---

Requirements

• Node.js - Minimum version: 16

---

🤩 Create your first technology

👉 Initialize your technology

npx @saagie/sdk init

If it does not work (npx is a little capricious on system with space in the path) go to the folder where you want your technology to be located:

npm init -y
npm install @saagie/sdk

Update the package.json to include this script command :

{
  "...": "...",
  "scripts": {
    "init": "saagie-sdk init"
  },
  "...": "..."
}

Now run to start the technology prompt:

npm run init

👉 Run your technology locally

npm run dev

👉 Build your technology

npm run build

👉 Create a new context

npm run new:context

---

📚 Technologies & Contexts documentation

▶️ Access the SDK documentation

Quick links:

• 📚 technology.yaml
• 📚 context.yaml

---

💻 CLI Commands

Usage: saagie-sdk [options] [command]

Options:
  -V, --version    output the version number
  -h, --help       display help for command

Commands:
  init             Create an empty Saagie External Technology project
  start [options]  Run local application
  build            Package your technology
  help [command]   display help for command

---

👩‍👨‍ Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.