Skip to content
Guide

Quickstart

Create an App and save your first Note in a sandbox.

Quickstart

Install Node.js 22.12+, npm 11.x, PHP 8.5.12+, and Composer. Create a developer account in the Console.

1. Install tools and connect a project

Run these commands where you want to keep your project:

Code example
Shell
npm install -g @nexia/cli@alpha
nexia setup --devtools
nexia create project my-project
cd my-project

Approve the connection in the browser. If you already created a project in Console, run nexia connect <project-id> in an empty project folder instead of create project. Copy the command with your project ID from Console's Development page.

2. Create an App and Note

Start in the connected project folder. Finish each command's prompts before continuing. Replace my-app with your folder name and supply your own package vendor when asked.

Code example
Shell
nexia create app my-app
cd my-app
composer install --no-scripts
npm install
nexia make resource Note --label-ko 노트
nexia dev

Keep dev running. For a new App, run nexia db migrate from the same App folder in a second terminal. Wait for completion before opening the App. Later file saves do not apply migrations; run the command again when ready.

dev registers the App, prepares the sandbox, and syncs source. Leave this terminal running while applying the first migration above.

Verify access and save a Note

  1. From Console Development, open the workspace, then go to Settings → Credentials and access.
  2. The sandbox owner automatically receives active permissions from ready development Apps. Use a test user below to check differences between permission sets.
  3. Open the workspace URL printed by the CLI. If you opened the workspace from Console, connect the CLI's local URL.
  4. Open your App → Operations → Notes and save a new Note. If you chose a different menu location, use that location.
  5. Refresh and reopen the Note to confirm the saved value remains.

Wait until the App runtime is ready before configuring access in the workspace. If Note is missing from the permission list, see Fix contribution discovery. For connection or startup failures, use Fix CLI installation and connection errors.

Test another user's permissions

  1. Prepare a test user in Directory → Users. The user must be active with a verified email.
  2. Select individual App permissions in Roles, then assign the role and its scope to the test user in Access. Leave the user without a role to check denied access.
  3. Choose Test as this user on the user detail page. Existing development App connections remain available, while screens and APIs use the selected user's actual permissions.
  4. Check reads, saves, and denied actions, then choose Return to developer in the top banner. Adjust permissions and repeat as needed.

This feature is limited to development sandboxes. Save unfinished work first: switching refreshes browser tabs for the same sandbox. Saves and deletes affect sandbox data. Testing skips initial password and two-factor setup screens without changing the account’s stored security settings.

Next task

Press Ctrl+C when you finish local development. Manage remote App execution and the sandbox in Console; Ctrl+C does not delete saved data.

See the public CLI documentation for command and option details.

Source of truth: docs/developers/content/en/getting-started/quickstart.md