skills.rest
steedos
steedosOFFICIAL
Explore all skills by this author →
WebsiteGitHub

steedos-getting-started

Provides Steedos platform overview, skill routing guidance, and CLI command reference.

1.6k|414|Updated Mar 4, 2019
Search Tags:#CLI#YAML#low-code#Routing#Onboarding#Metadata#steedos
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-getting-started
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: steedos-getting-started
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-getting-started
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-getting-started

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

New Steedos developers often don't know where to start, which skill matches their task, or how to use the Steedos CLI for starting servers, deploying metadata, and validating packages. This Skill provides a single orientation and routing guide.

Core Features & Use Cases

  • Platform Overview: Explains Steedos core concepts including objects, metadata YAML files, packages, triggers, functions, micro pages, and the Builder6 server.
  • Skill Routing: Maps common development intents (data modeling, business logic, UI pages, permissions, analytics, APIs) to the correct specialized Steedos skill.
  • CLI Reference: Documents commands such as steedos start, restart, source:deploy, source:retrieve, data:import/export, and package validation with @steedos/validate.
  • Use Case: A developer new to Steedos asks where to begin building an app; this Skill routes them through project setup, object definition, logic, UI, permissions, and deployment in the correct order.

Quick Start

Ask the assistant to explain what Steedos is and which skill to use for defining data models and deploying a package.

Frequently Asked Questions about steedos-getting-started

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

FAQPage Schema
How do I get started with the Steedos platform?▼

Start by creating a project package, then define objects and fields in YAML metadata, add triggers and functions for logic, build pages and apps for UI, and set permissions. Deploy everything using the steedos CLI commands like steedos start and steedos source:deploy.

Which Steedos skill should I use for my task?▼

Match your intent to a skill: steedos-objects for data models, steedos-server-logic for triggers and functions, steedos-pages for UI, steedos-object-permissions for access control, and steedos-analytics for dashboards. This routing guide maps each task type to its skill.

How do I restart a Steedos server during local development?▼

Run steedos restart, which reads the .steedos.pid file, sends SIGTERM to the running process, waits up to 30 seconds, then starts a new instance. It is intended for local development only, not Docker or Kubernetes deployments.

How do I validate a Steedos package before deployment?▼

Run npx @steedos/validate followed by the package path to check object names, field types, trigger locations, button schemas, and app code prefixes. Add the --json flag for CI-friendly output.

Does Steedos support databases other than MongoDB?▼

Yes, Steedos supports MongoDB, PostgreSQL, and MySQL as backend databases. All server-side code is JavaScript/TypeScript running on Node.js with NestJS and Moleculer microservices.

When should I not use the steedos restart command?▼

Avoid steedos restart in Docker or Kubernetes environments since it relies on a local PID file and foreground process. Use supervisord autorestart, docker service update, or kubectl rollout for containerized deployments instead.

Related Skills

Explore More Software Engineering Skills→
steedossteedos
1.6k

steedos-project-format

Scaffold Steedos projects with package.json and steedos-config.yml.

Official
Intermediate
steedossteedos
1.6k

steedos-objects

Define Steedos data models using YAML metadata files.

Official
Intermediate
steedossteedos
1.6k

steedos-package-format

Validate Steedos package structure and metadata conventions.

Official
Intermediate
steedossteedos
1.6k

steedos-object-functions

Define Steedos object functions in .function.yml and expose them as REST endpoints.

Official
Advanced