Console and CLI user
You do the day's work on the platform through its two clients: the web console and the platformctl command line. Both ask the services and show what they answer; neither decides anything on its own, so when one of them refuses, the reason comes from a service. This page points you to the help for each task.
Start here#
| If you work in | Read |
|---|---|
| The browser | Console overview, then the Console user guide |
| A terminal | CLI overview, then CLI usage |
New to the vocabulary? Concepts explains tenants, workspaces, collections, records and grants.
Everyday tasks#
| Task | In the console | With the CLI |
|---|---|---|
| Sign in and out | Sign in and out | Sign in |
| Find a workspace and browse its records | Find a workspace, Browse records | Everyday work |
| Create or edit a record | Create and edit a record | data items create, data items update (CLI spec §5.6) |
| See a record's history, or roll it back | Use history and rollback | data items versions, data items rollback (CLI spec §5.6) |
| Read a workspace's audit | Change the data model and read the audit | data audit (CLI spec §5.6) |
| Check service status | Read service status | status, doctor (CLI spec §5.1) |
| Read these docs | Use the built-in docs | — |
Operator tasks#
If you hold an operator scope, you also administer tenants. The step-by-step guides cover the whole job; the console and the CLI are two ways to do each step.
| Task | Guide | In the console |
|---|---|---|
| Grant or revoke access, manage groups and roles | Manage access | Administer a tenant |
| Bring a new tenant on | Onboard a tenant | Administer a tenant |
| Understand what your operator scope lets you do | Console spec §4 | — |
When something refuses#
| What happened | Where to look |
|---|---|
| The CLI refuses a command or exits with an error status | CLI usage: when something refuses, CLI spec §6 |
| A record cannot be read or saved | Data troubleshooting |
| Sign-in fails | Access troubleshooting: failed logins |
| Any other error from a request | Troubleshoot a request |
| The console hides an action you expected | Console spec §5 |