# ZeyOS guides — LLM index Client guide, iXML guide and SDK. All exports: /ai/guide/index.json ## Choose your task The `zeyos` skill route "Use ZeyOS business data" is listed under "Use a coding agent with ZeyOS". ### Build a ZeyOS app Write native iXML and Zymba that runs inside ZeyOS, and package it as an application. Prerequisites: The ZeyOS SDK (zeysdk) and a linked sandbox instance; Permission to send source to that instance. Read in this order: 1. Set up the SDK: /ixml/ixml-guide/development-environment/sdk#first-time-setup (Markdown: /ai/guide/ixml/ixml-guide/development-environment/sdk.md) 2. App structure: /ixml/ixml-guide/development-environment/app-structure (Markdown: /ai/guide/ixml/ixml-guide/development-environment/app-structure.md) 3. Execution contexts: /ixml/ixml-guide/development-environment/execution-contexts (Markdown: /ai/guide/ixml/ixml-guide/development-environment/execution-contexts.md) 4. Minimal app: /ixml/ixml-guide/development-environment/minimal-app (Markdown: /ai/guide/ixml/ixml-guide/development-environment/minimal-app.md) 5. Verification checkpoints: /ixml/ixml-guide/development-environment/verification-checkpoints (Markdown: /ai/guide/ixml/ixml-guide/development-environment/verification-checkpoints.md) First success: You run `zeysdk compile` on the minimal app against your sandbox and it reports no errors. The published sample compiles on a sandbox but has not been run on an instance, so this run is your first evidence for your own instance. Sample: Minimal app: /ixml/ixml-guide/development-environment/minimal-app Troubleshooting: Native troubleshooting: /ixml/ixml-guide/development-environment/troubleshooting Reference: /ixml, /zymba, /db, /sdk ### Connect an external application Read and write ZeyOS data from a service, browser app or script running outside ZeyOS. Prerequisites: Access to a ZeyOS instance; OAuth client credentials; Node.js 18 or later for the JavaScript client. Read in this order: 1. Integration architecture: /guide/tutorials/integration-architecture (Markdown: /ai/guide/guide/tutorials/integration-architecture.md) 2. Authentication: /guide/api-reference/authentication (Markdown: /ai/guide/guide/api-reference/authentication.md) 3. JavaScript client: getting started: /guide/javascript-client/getting-started (Markdown: /ai/guide/guide/javascript-client/getting-started.md) 4. Making requests: /guide/javascript-client/making-requests (Markdown: /ai/guide/guide/javascript-client/making-requests.md) 5. Server-side integrations: /guide/tutorials/server-side-integrations (Markdown: /ai/guide/guide/tutorials/server-side-integrations.md) First success: `client.schema.validate('listTickets', { fields: ['ID', 'name'] })` passes offline, then the same query returns your tickets. Sample: Dashboard sample app (read-only): /guide/sample-apps/dashboard Troubleshooting: Practical guide: /guide/javascript-client/practical-guide Reference: /api, /auth, /db ### Use a coding agent with ZeyOS Give a coding agent the authoritative references, project instructions and validation tools. Prerequisites: A coding agent such as Kilo Code, Pi or OpenCode; The ZeyOS CLI and client, version 1.0.0 or later. Read in this order: 1. Agent setup: /guide/agent-workflows/agent-setup (Markdown: /ai/guide/guide/agent-workflows/agent-setup.md) 2. Project instructions: /ai/agent-instructions.md 3. Agent quickstart: /guide/agent-workflows/agent-quickstart (Markdown: /ai/guide/guide/agent-workflows/agent-quickstart.md) 4. Native code validation: /ixml/ixml-guide/development-environment/coding-agents (Markdown: /ai/guide/ixml/ixml-guide/development-environment/coding-agents.md) First success: The agent follows the project instructions and shows a request preview without writing anything. Sample: Agent recipes: /guide/agent-workflows/agent-recipes Troubleshooting: CLI coverage and escalation: /guide/agent-workflows/cli-coverage-and-escalation Reference: /docs/ai, /ixml, /zymba, /api, /db #### Use ZeyOS business data Answer questions from your records, and run record operations you explicitly request, with or without an agent. Prerequisites: The `zeyos` CLI, signed in with `zeyos login`. Read in this order: 1. Agent quickstart: /guide/agent-workflows/agent-quickstart (Markdown: /ai/guide/guide/agent-workflows/agent-quickstart.md) 2. Agent recipes: /guide/agent-workflows/agent-recipes (Markdown: /ai/guide/guide/agent-workflows/agent-recipes.md) 3. Coding agents: /guide/agent-workflows/coding-agents (Markdown: /ai/guide/guide/agent-workflows/coding-agents.md) First success: `zeyos count accounts --filter '{"type":1,"visibility":0}'` prints your number of customers. Sample: Agent recipes: /guide/agent-workflows/agent-recipes Troubleshooting: CLI coverage and escalation: /guide/agent-workflows/cli-coverage-and-escalation ## AI & Integration Guide - ZeyOS for Agents and Applications: /ai/guide/guide.md - Agent Quickstart: /ai/guide/guide/agent-workflows/agent-quickstart.md - Agent Recipes: /ai/guide/guide/agent-workflows/agent-recipes.md - Agent Setup: /ai/guide/guide/agent-workflows/agent-setup.md - CLI Coverage and Escalation: /ai/guide/guide/agent-workflows/cli-coverage-and-escalation.md - Coding Agents: /ai/guide/guide/agent-workflows/coding-agents.md - Authentication: /ai/guide/guide/api-reference/authentication.md - Data Retrieval: /ai/guide/guide/api-reference/data-retrieval.md - Resources: /ai/guide/guide/api-reference/resources.md - Schema Reference: /ai/guide/guide/api-reference/schema.md - Commands Reference: /ai/guide/guide/cli/commands.md - Configuration: /ai/guide/guide/cli/configuration.md - CLI Getting Started: /ai/guide/guide/cli/getting-started.md - MCP Server: /ai/guide/guide/cli/mcp-server.md - Authentication: /ai/guide/guide/javascript-client/authentication.md - Getting Started: /ai/guide/guide/javascript-client/getting-started.md - Making API Requests: /ai/guide/guide/javascript-client/making-requests.md - Practical Implementation Guide: /ai/guide/guide/javascript-client/practical-guide.md - Keeping OKF Fresh: /ai/guide/guide/okf/keeping-fresh.md - Refining with Loops: /ai/guide/guide/okf/loops.md - OKF Overview: /ai/guide/guide/okf/overview.md - Producing & Consuming OKF: /ai/guide/guide/okf/producing-and-consuming.md - CRM Account List: /ai/guide/guide/sample-apps/crm.md - Dashboard: /ai/guide/guide/sample-apps/dashboard.md - Kanban Board: /ai/guide/guide/sample-apps/kanban.md - Application Developers: /ai/guide/guide/tutorials/application-developers.md - Browser UI Playbook: /ai/guide/guide/tutorials/build-your-own-zeyos-frontend.md - Integration Architecture: /ai/guide/guide/tutorials/integration-architecture.md - Server-Side Integrations: /ai/guide/guide/tutorials/server-side-integrations.md ## iXML Guide - Introduction: /ai/guide/ixml.md - Data Types: /ai/guide/ixml/ixml-guide/data-types.md - Arrays: /ai/guide/ixml/ixml-guide/data-types/arrays.md - Construction: /ai/guide/ixml/ixml-guide/data-types/arrays/construction.md - Filtering & Sorting: /ai/guide/ixml/ixml-guide/data-types/arrays/filtering-sorting.md - Inspection: /ai/guide/ixml/ixml-guide/data-types/arrays/inspection.md - Set Operations: /ai/guide/ixml/ixml-guide/data-types/arrays/set-operations.md - Slicing & Structuring: /ai/guide/ixml/ixml-guide/data-types/arrays/slicing.md - Stack & Queue: /ai/guide/ixml/ixml-guide/data-types/arrays/stack-queue.md - Booleans: /ai/guide/ixml/ixml-guide/data-types/booleans.md - Null and Undefined: /ai/guide/ixml/ixml-guide/data-types/null-and-undefined.md - Numbers: /ai/guide/ixml/ixml-guide/data-types/numbers.md - Strings: /ai/guide/ixml/ixml-guide/data-types/strings.md - Type Conversion: /ai/guide/ixml/ixml-guide/data-types/type-conversion.md - Database Operations: /ai/guide/ixml/ixml-guide/database-operations.md - Connections & Raw SQL: /ai/guide/ixml/ixml-guide/database-operations/connections.md - Extending the Data Model: /ai/guide/ixml/ixml-guide/database-operations/extending-data-model.md - Object Operations: /ai/guide/ixml/ixml-guide/database-operations/object-operations.md - SQL Operations: /ai/guide/ixml/ixml-guide/database-operations/sql-operations.md - Tags: /ai/guide/ixml/ixml-guide/database-operations/tags.md - Development Environment: /ai/guide/ixml/ixml-guide/development-environment.md - App Structure: /ai/guide/ixml/ixml-guide/development-environment/app-structure.md - Coding Agents and Native Code Validation: /ai/guide/ixml/ixml-guide/development-environment/coding-agents.md - Development Console: /ai/guide/ixml/ixml-guide/development-environment/dev-console.md - Execution Contexts: /ai/guide/ixml/ixml-guide/development-environment/execution-contexts.md - Minimal App: /ai/guide/ixml/ixml-guide/development-environment/minimal-app.md - SDK Workflow: /ai/guide/ixml/ixml-guide/development-environment/sdk.md - Troubleshooting: /ai/guide/ixml/ixml-guide/development-environment/troubleshooting.md - Verification Checkpoints: /ai/guide/ixml/ixml-guide/development-environment/verification-checkpoints.md - Error Handling & Debugging: /ai/guide/ixml/ixml-guide/error-handling.md - API Error Patterns: /ai/guide/ixml/ixml-guide/error-handling/api-error-patterns.md - Best Practices: /ai/guide/ixml/ixml-guide/error-handling/best-practices.md - Debugging & Troubleshooting: /ai/guide/ixml/ixml-guide/error-handling/debugging.md - Throwing Errors: /ai/guide/ixml/ixml-guide/error-handling/throwing-errors.md - Try / Catch: /ai/guide/ixml/ixml-guide/error-handling/try-catch.md - Arithmetic Expressions: /ai/guide/ixml/ixml-guide/introduction/arithmetic.md - Quick Reference: /ai/guide/ixml/ixml-guide/introduction/quick-reference.md - Result Propagation: /ai/guide/ixml/ixml-guide/introduction/result-propagation.md - Scope and Assignment: /ai/guide/ixml/ixml-guide/introduction/scope-and-assignment.md - Variables and Substitution: /ai/guide/ixml/ixml-guide/introduction/variables-and-substitution.md - Reusability and OOP: /ai/guide/ixml/ixml-guide/reusability-and-oop.md - Classes & Objects: /ai/guide/ixml/ixml-guide/reusability-and-oop/classes.md - Client Bindings: /ai/guide/ixml/ixml-guide/reusability-and-oop/clients.md - Functions & Includes: /ai/guide/ixml/ixml-guide/reusability-and-oop/functions.md - Macros: /ai/guide/ixml/ixml-guide/reusability-and-oop/macros.md - OOP Patterns: /ai/guide/ixml/ixml-guide/reusability-and-oop/patterns.md - Standard Library: /ai/guide/ixml/ixml-guide/standard-library.md - Encoding and Decoding: /ai/guide/ixml/ixml-guide/standard-library/encoding.md - Excel and ZIP: /ai/guide/ixml/ixml-guide/standard-library/excel-zip.md - File & Storage Operations: /ai/guide/ixml/ixml-guide/standard-library/filesystem.md - REST and HTTP Operations: /ai/guide/ixml/ixml-guide/standard-library/http-rest.md - Mathematics and Date/Time: /ai/guide/ixml/ixml-guide/standard-library/math-datetime.md - PDF Generation: /ai/guide/ixml/ixml-guide/standard-library/pdf.md - Syntax Essentials: /ai/guide/ixml/ixml-guide/syntax-essentials.md - Branching: /ai/guide/ixml/ixml-guide/syntax-essentials/branching.md - Conditionals: /ai/guide/ixml/ixml-guide/syntax-essentials/conditionals.md - Loops: /ai/guide/ixml/ixml-guide/syntax-essentials/loops.md - Output & Serialization: /ai/guide/ixml/ixml-guide/syntax-essentials/output.md - String Operations: /ai/guide/ixml/ixml-guide/syntax-essentials/strings.md - Type Introspection: /ai/guide/ixml/ixml-guide/syntax-essentials/type-introspection.md - Variables: /ai/guide/ixml/ixml-guide/syntax-essentials/variables.md - User Interface & Forms: /ai/guide/ixml/ixml-guide/user-interface.md - Exports: /ai/guide/ixml/ixml-guide/user-interface/exports.md - Forms: /ai/guide/ixml/ixml-guide/user-interface/forms.md - Weblets: /ai/guide/ixml/ixml-guide/user-interface/weblets.md ## SDK - ZeyOS SDK Documentation: /ai/guide/sdk.md - Application Activity Management: /ai/guide/sdk/activity-management.md - Activate Application: /ai/guide/sdk/activity-management/zeysdk-activate.md - Deactivate Application: /ai/guide/sdk/activity-management/zeysdk-deactivate.md - Pre-delete Application: /ai/guide/sdk/activity-management/zeysdk-predelete.md - Application Management: /ai/guide/sdk/application-management.md - Clone Application: /ai/guide/sdk/application-management/zeysdk-clone.md - Configure Application: /ai/guide/sdk/application-management/zeysdk-configure.md - Create Application: /ai/guide/sdk/application-management/zeysdk-create.md - Delete Application: /ai/guide/sdk/application-management/zeysdk-delete.md - Host Commands: /ai/guide/sdk/application-management/zeysdk-host.md - Migrate Application: /ai/guide/sdk/application-management/zeysdk-migrate.md - Rollout Application: /ai/guide/sdk/application-management/zeysdk-rollout.md - Asset Management: /ai/guide/sdk/asset-management.md - Add Asset: /ai/guide/sdk/asset-management/zeysdk-add.md - Remove Asset: /ai/guide/sdk/asset-management/zeysdk-remove.md - Rename Asset: /ai/guide/sdk/asset-management/zeysdk-rename.md - Update Asset: /ai/guide/sdk/asset-management/zeysdk-update.md - Authentication: /ai/guide/sdk/authentication.md - Bundle Management: /ai/guide/sdk/bundle-management.md - Create Bundle: /ai/guide/sdk/bundle-management/zeysdk-bundle-create.md - Install Bundle: /ai/guide/sdk/bundle-management/zeysdk-bundle-install.md - Configuration Files: /ai/guide/sdk/configuration-files.md - Debugging and Compilation: /ai/guide/sdk/debugging.md - ZeyOS Entities: /ai/guide/sdk/entities.md - Platform Management: /ai/guide/sdk/platform-management.md - Link Instance: /ai/guide/sdk/platform-management/zeysdk-link.md - Unlink Instance: /ai/guide/sdk/platform-management/zeysdk-unlink.md - Use Instance: /ai/guide/sdk/platform-management/zeysdk-use.md - Show Current Instance: /ai/guide/sdk/platform-management/zeysdk-whoami.md - Snapshot Management: /ai/guide/sdk/snapshot-management.md - Create Snapshot: /ai/guide/sdk/snapshot-management/zeysdk-snapshot-create.md - Delete Snapshot: /ai/guide/sdk/snapshot-management/zeysdk-snapshot-delete.md - List Snapshots: /ai/guide/sdk/snapshot-management/zeysdk-snapshot-list.md - Restore Snapshot: /ai/guide/sdk/snapshot-management/zeysdk-snapshot-restore.md - Synchronization: /ai/guide/sdk/synchronization.md - Compare Files (zeysdk compare): /ai/guide/sdk/synchronization/zeysdk-compare.md - Pull Files: /ai/guide/sdk/synchronization/zeysdk-pull.md - Push Files: /ai/guide/sdk/synchronization/zeysdk-push.md - Recover Sync State: /ai/guide/sdk/synchronization/zeysdk-recover.md - Sync Files (zeysdk sync): /ai/guide/sdk/synchronization/zeysdk-sync.md - Watch Files: /ai/guide/sdk/synchronization/zeysdk-watch.md - ZeyOS Views Reference: /ai/guide/sdk/views.md