Installing Apps
oikapi applications are distributed as .oikapp packages — compressed archives containing table definitions, roles, permissions, business rules, and operation history.
Installing from the marketplace
Section titled “Installing from the marketplace”The simplest way to install apps is from the marketplace, using @provider/name references:
oi app install @oikapi/crm # latest versionoi app install @oikapi/crm@1.0.0 # a specific versionFirst-party apps
Section titled “First-party apps”These suites are published by the oikapi team:
| App | Description |
|---|---|
| CRM | Leads, opportunity pipeline, and activities |
| Sales | Quote-to-cash — quotes, orders, invoices, payments, subscriptions |
| ITSM | Incidents, changes, problems, and a service catalog with SLAs |
| CMDB | Typed configuration items, a dependency graph, and discovery-fed reconciliation |
| Inventory | Products, stock levels, movements, and physical counts |
| HR Core | Employees, departments, the org-chart graph, leave, attendance, compensation |
| Purchasing | Vendor management, purchase orders, goods receipts, and vendor bills |
| Projects | Projects, work items, dependencies, milestones, and time tracking |
| Event Management | Ingest monitoring events, deduplicate into alerts, and auto-raise incidents |
| Discovery | Scheduled refresh of CMDB items and relationships from a source |
| Accounting Integrations | Receives GL postings from operational suites and syncs to an external accounting system |
Many suites build on a shared spine — for example ITSM, Event Management, and Discovery rely on CMDB. Dependencies are resolved automatically and installed in the correct order.
Installing from a file or directory
Section titled “Installing from a file or directory”You can also install from a local .oikapp package or a source directory:
oi app install ./crm-1.0.0.oikapp # pre-built package fileoi app install ./my-app # a source directory (built, then installed)oi app install ./apps # all apps found under a directoryInstall options
Section titled “Install options”# Install and rename (fork as a customizable template)oi app install @oikapi/crm --as my-crm
# Auto-approve cross-app access requests during installoi app install @oikapi/itsm --auto-approveWhen an app needs access to tables owned by another application, the installer records a cross-app access request. Pending requests are managed with oi access pending. Demo data is managed separately via oi app demo.
What gets installed
Section titled “What gets installed”| Included | Not included |
|---|---|
| Table definitions and fields | Record data |
| Roles | User accounts |
| Permission grants | Session data |
| Business rules and scripts | Runtime state |
Checking installed apps
Section titled “Checking installed apps”oi app listFor full package install metadata (version, install time, who installed it, and signature verification status):
oi api GET /api/applications/installedPackage signatures
Section titled “Package signatures”Packages can be signed with Ed25519 keys. Trust levels:
| Level | Meaning |
|---|---|
official | Signed by the oikapi team |
verified | Signed by a verified third-party developer |
community | Signed by a community member |
unsigned | No signature |
Updating and removing apps
Section titled “Updating and removing apps”oi app update crm # update an installed applicationoi app uninstall crm # uninstall an applicationoi app deps # show the dependency graphReinstallation
Section titled “Reinstallation”If an application was previously deleted, installing the same package will restore it.
Customizing installed apps
Section titled “Customizing installed apps”After installation, you can:
- Add new fields to existing tables
- Create additional tables in the same application
- Modify permissions and roles
- Add or edit business rules
- Build custom web interfaces