name: scitex-app
description: |
[WHAT] App-developer SDK for SciTeX workspace apps — write-once for local + cloud, zero-dep stdlib.
[WHEN] Use when the user asks to "scaffold a SciTeX app", "init a workspace app", "validate my app manifest", "dev-install" (→ CLI), "submit the app" (→ CLI), "read/write files with auto local/cloud backend", "register an S3 backend", "run this app standalone", "build a file tree", or mentions manifest. [HOW] pip install scitex-appthenimport scitex_app`; see leaf skills for details.
tags: [scitex-app]
allowed-tools: mcp__scitex__app_*
primary_interface: cli
interfaces:
python: 2
cli: 3
mcp: 2
skills: 2
http: 0
scitex-app — App Developer SDK
Toolkit for building SciTeX workspace apps with scaffold, validation, standalone mode, and cloud integration.
Installation & import (two equivalent paths)
The same module is reachable via two install paths. Both forms work at runtime; which one a user has depends on their install choice.
# Standalone — pip install scitex-app
import scitex_app
scitex_app.get_files(...)
# Umbrella — pip install scitex
import scitex.app
scitex.app.get_files(...)
pip install scitex-app alone does NOT expose scitex.app — also
pip install scitex for the umbrella form. See
[../../general/02_interface-python-api.md] for the ecosystem-wide rule.
Leaves
Mandatory (SK105–108)
- 01_installation — pip install + smoke verify
- 02_quick-start — scaffold → validate → dev-install
- 03_python-api — top-level Python surface
- 04_cli-reference — full
scitex-appsubcommand surface
Core SDK / interfaces
- 05_standalone
- 06_environment-vars
- 07_backend-validation — App validation pipeline + minimal-app checklist
Workflows / references
- 10_app-lifecycle — End-to-end: scaffold → develop → validate → dev-install → test → submit.
- 11_app-registration — Workspace sidebar registration via manifest.json → ModuleConfig.
- 12_app-develop — Development patterns: views, urls, templates, CSS scoping, React bridge.
- 13_app-validate-install — Validate, dev-install, browser testing, troubleshooting.
- 14_app-lifecycle-deploy — Lifecycle Steps 3-6 (validate/dev-install/test/submit) + figrecipe reference.
- 15_manifest-schema — Complete manifest.json schema reference.
- 16_app-registration-internals — Sidebar render, partial load, entry points, source files, troubleshooting.
- 17_app-develop-frontend — CSS scoping, React frontend, Files SDK in views.
- 18_app-test-troubleshoot — Browser testing, standalone mode, troubleshooting catalogue, env vars.
Detailed SDK references (legacy 01–04)
- 19_files-sdk — Files SDK surface (was 01)
- 30_backend-sdk — backend developer SDK (was 02)
- 31_paths —
pathssubmodule (was 03) - 32_cli — original CLI page (was 04)
Quick Start
scitex-app app init . --name my_app
scitex-app app validate .
scitex-app app dev-install . --server http://127.0.0.1:8000
Python API examples live in 03_python-api.md and the detailed 19_files-sdk.md.