steedos-package-format

Validate Steedos package structure and metadata conventions.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-package-format
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-package-format
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-package-format
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-package-format

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Steedos packages can be complex to structure and maintain; this Skill clarifies the required layout, core metadata files, and conventions to reduce setup errors and onboarding time.

Core Features & Use Cases

  • Provides a clear package layout including package.json, package.service.js, and main/default/objects with nested metadata.
  • Documents the allowed metadata types (objects, triggers, functions, pages, tabs, permissions, etc.) and naming conventions.
  • Great for onboarding new teams and validating an existing package against the standard.

Quick Start

Create a new package following the documented structure and run the validator to ensure correct naming and metadata.

Frequently Asked Questions about steedos-package-format

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is the required folder layout for a Steedos package?

The standard Steedos package structure requires package.json, package.service.js, and a main/default/objects directory for nested metadata files.

How do I validate Steedos package metadata and naming conventions?

You can validate a Steedos package by running the validator against the documented structure to ensure correct metadata types and file naming conventions are applied.

What metadata types are supported in the Steedos package structure?

Steedos packages support metadata types including objects, triggers, functions, pages, tabs, and permissions, alongside optional components like scripts, references, and assets.

Can I use optional components like scripts and assets in my Steedos package?

Yes, the Steedos package structure accommodates optional components including scripts, references, and assets within its recommended folder layout.

Why does my Steedos package validation fail on missing required files?

Validation fails when the package lacks required files like package.json or package.service.js, or if the nested metadata directory layout violates naming conventions.