From 9b665774219060895a48523c9c90fcbeed9251b9 Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Tue, 2 Jun 2026 21:11:31 -0600 Subject: [PATCH 1/2] docs: add harper describe_data verification step to getting-started guide After running `harper dev .`, new users had no way to confirm their schema.graphql was processed and the Dog table was created before moving on to enabling the REST API. Adds a "Verifying the Table Was Created" section that shows `harper describe_data` and its expected output. Paired with HarperFast/harper#1110 which adds the command. Co-Authored-By: Claude Sonnet 4.6 --- .../create-your-first-application.mdx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/learn/getting-started/create-your-first-application.mdx b/learn/getting-started/create-your-first-application.mdx index 93cabf60..ab849f73 100644 --- a/learn/getting-started/create-your-first-application.mdx +++ b/learn/getting-started/create-your-first-application.mdx @@ -157,6 +157,24 @@ Click "Restart Cluster" to apply the new file changes. +## Verifying the Table Was Created + +Once Harper has started, confirm your `Dog` table was picked up from `schema.graphql` by running: + +```bash +harper describe_data +``` + +You should see output like: + +``` +Connecting to local Harper instance +Schema: data + Dog [id*, name, breed, age] +``` + +The asterisk marks the primary key. If the table is missing, double-check that `config.yaml` references the correct schema file and that Harper restarted after the file was saved. + ## Enabling the REST API Navigate back to the `schema.graphql` file and add `@export` directive to the table schema: From c9934e9a891e4579e1dee268cd85509e39b92672 Mon Sep 17 00:00:00 2001 From: Kris Zyp Date: Tue, 2 Jun 2026 21:14:46 -0600 Subject: [PATCH 2/2] docs: use describe_database for table verification step Switch from the (now-closed) describe_data proposal to the existing harper describe_database database=data operation, which already works via the CLI passthrough. Co-Authored-By: Claude Sonnet 4.6 --- .../create-your-first-application.mdx | 26 ++++++++++++++----- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/learn/getting-started/create-your-first-application.mdx b/learn/getting-started/create-your-first-application.mdx index ab849f73..887657cf 100644 --- a/learn/getting-started/create-your-first-application.mdx +++ b/learn/getting-started/create-your-first-application.mdx @@ -162,18 +162,30 @@ Click "Restart Cluster" to apply the new file changes. Once Harper has started, confirm your `Dog` table was picked up from `schema.graphql` by running: ```bash -harper describe_data +harper describe_database database=data ``` -You should see output like: +You should see YAML output describing the `Dog` table and its attributes: -``` -Connecting to local Harper instance -Schema: data - Dog [id*, name, breed, age] +```yaml +Dog: + schema: data + name: Dog + primary_key: id + attributes: + - attribute: id + type: ID + is_primary_key: true + - attribute: name + type: String + - attribute: breed + type: String + - attribute: age + type: Int + ... ``` -The asterisk marks the primary key. If the table is missing, double-check that `config.yaml` references the correct schema file and that Harper restarted after the file was saved. +If the table is missing, double-check that `config.yaml` references the correct schema file and that Harper restarted after the file was saved. ## Enabling the REST API