@lowdefy/docs-content 6.1.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/content/actions/downloadcsv.md +1 -1
- package/content/actions/emailotpsend.md +58 -0
- package/content/actions/emailotpverify.md +79 -0
- package/content/actions/getlocalstorage.md +43 -0
- package/content/actions/link.md +47 -1
- package/content/actions/login.md +25 -5
- package/content/actions/logout.md +7 -5
- package/content/actions/magiclinkverify.md +117 -0
- package/content/actions/pdfmake.md +2 -2
- package/content/actions/posthogalias.md +29 -0
- package/content/actions/posthogcapture.md +49 -0
- package/content/actions/posthogcapturepageleave.md +38 -0
- package/content/actions/posthogfeatureflag.md +50 -0
- package/content/actions/posthoggroup.md +37 -0
- package/content/actions/posthogidentify.md +54 -0
- package/content/actions/posthoginit.md +96 -0
- package/content/actions/posthogoptin.md +29 -0
- package/content/actions/posthogoptout.md +29 -0
- package/content/actions/posthogpageview.md +37 -0
- package/content/actions/posthogreloadfeatureflags.md +47 -0
- package/content/actions/posthogreset.md +28 -0
- package/content/actions/posthogsetpersonproperties.md +36 -0
- package/content/actions/removelocalstorage.md +28 -0
- package/content/actions/resetvalidation.md +7 -3
- package/content/actions/setdarkmode.md +3 -3
- package/content/actions/setglobal.md +2 -0
- package/content/actions/setlocale.md +1 -1
- package/content/actions/setlocalstorage.md +34 -0
- package/content/actions/validate.md +7 -4
- package/content/adapter-reference/mongodbauthadapter.md +46 -0
- package/content/agents/agent-endpoint-tools.md +24 -0
- package/content/agents/agent-properties.md +13 -3
- package/content/agents/agent-server-hooks.md +1 -1
- package/content/agents/agentchat.md +43 -7
- package/content/agents/agentconversations.md +42 -8
- package/content/agents/agents-introduction.md +107 -0
- package/content/callback-reference/auth0logoutcallback.md +54 -0
- package/content/concepts/ai-agent-docs.md +455 -106
- package/content/concepts/blocks.md +150 -0
- package/content/concepts/connections-and-requests.md +402 -0
- package/content/concepts/custom-html.md +42 -0
- package/content/concepts/custom-styling.md +50 -5
- package/content/concepts/dynamic-page-content.md +309 -0
- package/content/concepts/events-and-actions.md +154 -2
- package/content/concepts/four-primitives.md +31 -0
- package/content/concepts/html-attributes.md +293 -0
- package/content/concepts/i18n.md +8 -3
- package/content/concepts/keyboard-shortcuts.md +2 -2
- package/content/concepts/layout-overview.md +1 -1
- package/content/concepts/logger.md +99 -0
- package/content/concepts/lowdefy-api.md +1319 -0
- package/content/concepts/lowdefy-schema.md +136 -3
- package/content/concepts/menus.md +8 -7
- package/content/concepts/module-authoring.md +76 -5
- package/content/concepts/modules.md +3 -1
- package/content/concepts/notifications.md +180 -0
- package/content/concepts/operators.md +7 -0
- package/content/concepts/page-and-app-state.md +252 -0
- package/content/concepts/page-paths.md +209 -0
- package/content/concepts/theming.md +582 -0
- package/content/connections/aigateway.md +375 -0
- package/content/connections/anthropic.md +169 -2
- package/content/connections/awss3.md +178 -2
- package/content/connections/axioshttp.md +181 -0
- package/content/connections/google.md +169 -2
- package/content/connections/mongodb.md +1014 -3
- package/content/connections/openai-connection.md +169 -2
- package/content/connections/sendgridmail.md +2 -0
- package/content/connections/smtp.md +3 -1
- package/content/connections/treg.md +329 -0
- package/content/container-blocks/affix.md +47 -7
- package/content/container-blocks/alert.md +76 -24
- package/content/container-blocks/badge.md +100 -24
- package/content/container-blocks/box.md +9 -9
- package/content/container-blocks/card.md +132 -27
- package/content/container-blocks/carousel.md +60 -7
- package/content/container-blocks/collapse.md +153 -9
- package/content/container-blocks/configprovider.md +35 -13
- package/content/container-blocks/confirmmodal.md +69 -23
- package/content/container-blocks/content.md +62 -98
- package/content/container-blocks/descriptions.md +45 -4
- package/content/container-blocks/drawer.md +139 -28
- package/content/container-blocks/dropdownmenu.md +119 -31
- package/content/container-blocks/flex.md +40 -62
- package/content/container-blocks/footer.md +15 -11
- package/content/container-blocks/googlemapsheatmap.md +1 -1
- package/content/container-blocks/googlemapsscript.md +2 -2
- package/content/container-blocks/header.md +71 -36
- package/content/container-blocks/label.md +34 -7
- package/content/container-blocks/layout.md +52 -34
- package/content/container-blocks/masonry.md +17 -71
- package/content/container-blocks/mobilemenu.md +131 -88
- package/content/container-blocks/modal.md +161 -26
- package/content/container-blocks/pageheadermenu.md +138 -31
- package/content/container-blocks/pagesidebarlayout.md +230 -27
- package/content/container-blocks/pagesidermenu.md +153 -43
- package/content/container-blocks/popover.md +34 -31
- package/content/container-blocks/result.md +32 -21
- package/content/container-blocks/sider.md +85 -122
- package/content/container-blocks/span.md +7 -7
- package/content/container-blocks/spinner.md +3 -3
- package/content/container-blocks/splitter.md +150 -68
- package/content/container-blocks/tabs.md +64 -12
- package/content/container-blocks/tooltip.md +22 -46
- package/content/container-blocks/watermark.md +22 -4
- package/content/controls/parallel_for.md +21 -2
- package/content/controls/reject.md +24 -3
- package/content/controls/return.md +17 -1
- package/content/controls/throw.md +1 -0
- package/content/controls/try.md +4 -2
- package/content/controls/while.md +46 -0
- package/content/deployment/deployment-environments.md +10 -7
- package/content/deployment/docker.md +22 -7
- package/content/deployment/node-server.md +4 -0
- package/content/deployment/vercel.md +17 -6
- package/content/display-blocks/aggrid.md +36 -19
- package/content/display-blocks/anchor.md +16 -15
- package/content/display-blocks/avatar.md +57 -37
- package/content/display-blocks/breadcrumb.md +70 -21
- package/content/display-blocks/button.md +93 -19
- package/content/display-blocks/calendar.md +12 -0
- package/content/display-blocks/clickablehtml.md +239 -0
- package/content/display-blocks/dangeroushtml.md +1 -1
- package/content/display-blocks/difflist.md +1 -1
- package/content/display-blocks/difftimeline.md +1 -1
- package/content/display-blocks/divider.md +64 -3
- package/content/display-blocks/dropdownbutton.md +81 -30
- package/content/display-blocks/echart.md +35 -1
- package/content/display-blocks/eventlog.md +363 -0
- package/content/display-blocks/floatbutton.md +129 -42
- package/content/display-blocks/html.md +61 -1
- package/content/display-blocks/icon.md +250 -67
- package/content/display-blocks/img.md +2 -2
- package/content/display-blocks/menu.md +146 -73
- package/content/display-blocks/message.md +38 -124
- package/content/display-blocks/notification.md +94 -222
- package/content/display-blocks/paragraph.md +59 -9
- package/content/display-blocks/pollingtimer.md +263 -0
- package/content/display-blocks/progress.md +96 -17
- package/content/display-blocks/qrcode.md +19 -4
- package/content/display-blocks/s3download.md +1 -1
- package/content/display-blocks/search.md +19 -9
- package/content/display-blocks/skeletonbutton.md +1 -0
- package/content/display-blocks/skeletoninput.md +1 -0
- package/content/display-blocks/statistic.md +75 -17
- package/content/display-blocks/steps.md +58 -25
- package/content/display-blocks/table.md +2527 -0
- package/content/display-blocks/tablelight.md +621 -0
- package/content/display-blocks/tag.md +102 -17
- package/content/display-blocks/title.md +50 -11
- package/content/display-blocks/tour.md +33 -23
- package/content/input-blocks/autocomplete.md +81 -9
- package/content/input-blocks/buttonselector.md +45 -8
- package/content/input-blocks/captcha.md +40 -0
- package/content/input-blocks/checkboxselector.md +97 -7
- package/content/input-blocks/checkboxswitch.md +33 -3
- package/content/input-blocks/colorselector.md +63 -14
- package/content/input-blocks/daterangeselector.md +165 -45
- package/content/input-blocks/dateselector.md +139 -41
- package/content/input-blocks/datetimeselector.md +158 -49
- package/content/input-blocks/inputgallery.md +3 -3
- package/content/input-blocks/intentinput.md +207 -0
- package/content/input-blocks/monthselector.md +120 -52
- package/content/input-blocks/multipleselector.md +150 -39
- package/content/input-blocks/numberinput.md +98 -12
- package/content/input-blocks/pagination.md +70 -14
- package/content/input-blocks/paragraphinput.md +51 -37
- package/content/input-blocks/passwordinput.md +60 -6
- package/content/input-blocks/phonenumberinput.md +59 -26
- package/content/input-blocks/placesautocomplete.md +319 -0
- package/content/input-blocks/radioselector.md +83 -7
- package/content/input-blocks/ratingslider.md +57 -26
- package/content/input-blocks/s3uploadbutton.md +24 -24
- package/content/input-blocks/s3uploaddragger.md +3 -3
- package/content/input-blocks/s3uploadphoto.md +5 -5
- package/content/input-blocks/segmentedselector.md +72 -32
- package/content/input-blocks/selector.md +109 -21
- package/content/input-blocks/switch.md +65 -17
- package/content/input-blocks/tableinput.md +445 -0
- package/content/input-blocks/tagmultipleselector.md +114 -0
- package/content/input-blocks/tagselector.md +114 -0
- package/content/input-blocks/textarea.md +32 -3
- package/content/input-blocks/textinput.md +70 -29
- package/content/input-blocks/tiptapinput.md +1 -1
- package/content/input-blocks/tiptapmentioninput.md +2 -2
- package/content/input-blocks/titleinput.md +39 -12
- package/content/input-blocks/treeinput.md +49 -25
- package/content/input-blocks/treemultipleselector.md +127 -10
- package/content/input-blocks/treeselector.md +97 -9
- package/content/input-blocks/upload.md +64 -15
- package/content/input-blocks/uploaddragger.md +17 -1
- package/content/input-blocks/uploadphoto.md +18 -1
- package/content/input-blocks/weekselector.md +120 -55
- package/content/learn/introduction.md +27 -0
- package/content/learn/quickstart.md +53 -0
- package/content/list-blocks/controlledlist.md +24 -15
- package/content/list-blocks/list.md +11 -11
- package/content/list-blocks/masonrylist.md +7 -34
- package/content/migration/auth-upgrade.md +337 -0
- package/content/migration/upgrade-guide.md +1 -0
- package/content/migration/v3-to-v4.md +417 -0
- package/content/migration/v6-to-v7.md +620 -0
- package/content/operators/_agent.md +155 -0
- package/content/operators/_app.md +2 -1
- package/content/operators/_array.md +122 -1
- package/content/operators/_build.md +1 -0
- package/content/operators/_credential.md +57 -0
- package/content/operators/_cron.md +292 -0
- package/content/operators/_date.md +2 -0
- package/content/operators/_error.md +24 -1
- package/content/operators/_get.md +6 -6
- package/content/operators/_hmac.md +78 -0
- package/content/operators/_js.md +2 -1
- package/content/operators/_location.md +1 -1
- package/content/operators/_media.md +13 -0
- package/content/operators/_module.md +56 -2
- package/content/operators/_operator.md +17 -3
- package/content/operators/_path_params.md +82 -0
- package/content/operators/_ref.md +258 -0
- package/content/operators/_request.md +1 -1
- package/content/operators/_request_details.md +6 -0
- package/content/operators/_type.md +14 -3
- package/content/operators/_url_query.md +2 -0
- package/content/operators/_user.md +3 -3
- package/content/plugins/plugins-actions.md +10 -0
- package/content/plugins/plugins-connections.md +25 -0
- package/content/plugins/plugins-dev.md +66 -0
- package/content/plugins/plugins-icon-sets.md +267 -0
- package/content/plugins/plugins-introduction.md +27 -1
- package/content/plugins/plugins.md +19 -0
- package/content/plugins/posthog.md +359 -0
- package/content/provider-reference/auth-js-providers.md +107 -0
- package/content/provider-reference/openidconnectprovider.md +44 -0
- package/content/recipes/recipes.md +16 -0
- package/content/reference/actions-reference.md +31 -0
- package/content/reference/blocks-reference.md +35 -0
- package/content/reference/cli.md +403 -0
- package/content/reference/connections-reference.md +23 -0
- package/content/reference/operators-reference.md +47 -0
- package/content/reference/reference.md +16 -0
- package/content/reference/schema-reference.md +12 -0
- package/content/testing/config-tests.md +677 -0
- package/content/testing/e2e-configuration.md +31 -1
- package/content/testing/e2e-getting-started.md +1 -1
- package/content/testing/e2e-introduction.md +1 -1
- package/content/testing/e2e-writing-tests.md +12 -1
- package/content/testing/explore-pull-request.md +136 -0
- package/content/testing/journey-data-sets.md +326 -0
- package/content/tutorial/tutorial-actions-operators.md +2 -2
- package/content/tutorial/tutorial-add-blocks.md +2 -2
- package/content/tutorial/tutorial-create-page.md +48 -2
- package/content/tutorial/tutorial-display-data-page.md +3 -3
- package/content/tutorial/tutorial-requests-api.md +155 -0
- package/content/tutorial/tutorial-requests-sql.md +153 -0
- package/content/tutorial/tutorial-start.md +66 -1
- package/content/user-authentication/auth-configuration.md +267 -0
- package/content/user-authentication/auth-providers.md +24 -0
- package/content/user-authentication/auth-steps.md +141 -0
- package/content/user-authentication/login-and-logout.md +160 -8
- package/content/user-authentication/mcp-oauth.md +424 -0
- package/content/user-authentication/organizations.md +246 -0
- package/content/user-authentication/protected-pages-apis.md +97 -0
- package/content/user-authentication/roles.md +49 -0
- package/content/user-authentication/two-factor.md +229 -0
- package/content/user-authentication/user-object.md +58 -0
- package/content/user-authentication/users-introduction.md +8 -0
- package/content/websockets/websocket-publish.md +105 -0
- package/content/websockets/websocket-subscriptions.md +136 -0
- package/content/websockets/websockets-introduction.md +101 -0
- package/hazards.json +44 -0
- package/index.json +3691 -14
- package/package.json +11 -1
- package/scripts/collectImportedFiles.js +80 -0
- package/scripts/extractAgentDocs.js +41 -30
- package/scripts/hashDocSources.js +38 -0
- package/scripts/isRedirectPage.js +26 -0
- package/scripts/recordSourceHashes.js +100 -0
- package/scripts/resolvePageSections.js +42 -0
- package/scripts/sectionKind.js +27 -0
- package/content/concepts/cli.md +0 -223
- package/content/other/introduction.md +0 -39
- package/content/other/next-auth-providers.md +0 -3
- /package/content/{other → actions}/updatesession.md +0 -0
package/content/concepts/cli.md
DELETED
|
@@ -1,223 +0,0 @@
|
|
|
1
|
-
# The CLI
|
|
2
|
-
|
|
3
|
-
The Lowdefy CLI is used to develop a Lowdefy app locally, and to build Lowdefy apps for deployment.
|
|
4
|
-
|
|
5
|
-
We recommend running the CLI using `pnpx`, to always use the latest version:
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
pnpx lowdefy@5 <command>
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
or, to use a specific version:
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
pnpx lowdefy@version <command>
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Alternative, you can install the CLI globally or to a Javascript project (with a `package.json` file) via pnpm.
|
|
18
|
-
|
|
19
|
-
To install the CLI globally run:
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
pnpm add -g lowdefy
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
The CLI can then be run using `lowdefy` as the executable name:
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
lowdefy <command>
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
# CLI commands
|
|
32
|
-
|
|
33
|
-
## build
|
|
34
|
-
|
|
35
|
-
The `build` command runs a Lowdefy build. This builds a production Lowdefy app in the server directory, which can then be started using the `lowdefy start` command. The options are:
|
|
36
|
-
|
|
37
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
38
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
39
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
40
|
-
- `--no-client-build`: Do not run the Vite client build, and only build the Lowdefy config. Used in some deployment scripts where the client build is done as a separate step. The previous `--no-next-build` flag still works as a deprecated alias.
|
|
41
|
-
- `--ref-resolver <ref-resolver-function-path>`: Path to a JavaScript file containing a `_ref` resolver function to be used as the app default `_ref` resolver.
|
|
42
|
-
- `--server-directory <server-directory>`: Change the server directory, the directory in which the production server is placed. The default is `<config-directory>/.lowdefy/server`.
|
|
43
|
-
- `--skip-codemod-check`: Suppress warnings about pending codemod upgrades.
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
## dev
|
|
47
|
-
|
|
48
|
-
The `dev` command starts a Lowdefy development server, running locally. It can be accessed in a browser at [http://localhost:3000](http://localhost:3000). The CLI watches the file system, and rebuilds the app and reloads served pages every time a change is made to any of the files in the project directory. The `dev` command should not be used to serve a production app, the `build` and `start` commands should be used instead.
|
|
49
|
-
|
|
50
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
51
|
-
- `--dev-directory <dev-directory>`: Change the dev directory, the directory in which the development server is placed. The default is `<config-directory>/.lowdefy/dev`.
|
|
52
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
53
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
54
|
-
- `--mock-user [user]`: Start the dev server authenticated as a mock user, bypassing the login flow. Pass a JSON user object to set the identity and roles (e.g. `--mock-user '{"sub":"dev","roles":["admin"]}'`), or use the bare flag for a default user with no roles. This is the same mechanism as `auth.dev.mockUser`. Dev server only. See [Auth Configuration](/auth-configuration#mock-user-for-testing-dev-server-only).
|
|
55
|
-
- `--no-open`: Do not open a new tab in the default browser.
|
|
56
|
-
- `--port <port>`: Change the port the server is hosted at. The default is `3000`.
|
|
57
|
-
- `--ref-resolver <ref-resolver-function-path>`: Path to a JavaScript file containing a `_ref` resolver function to be used as the app default `_ref` resolver.
|
|
58
|
-
- `--watch <paths...>`: A list of paths to files or directories that should be watched for changes. Globs are supported. Specify each path to watch separated by spaces.
|
|
59
|
-
- `--watch-ignore <patterns...>`: A list of paths to files or directories that should be ignored by the file watcher. Globs are supported. Specify each path to watch separated by spaces.
|
|
60
|
-
- `--skip-codemod-check`: Suppress warnings about pending codemod upgrades.
|
|
61
|
-
|
|
62
|
-
## emails
|
|
63
|
-
|
|
64
|
-
The `emails` command previews the [notification](/notifications) emails your app renders, using [React Email](https://react.email/)'s preview server. It builds the app, renders each notification from its `testData`, and opens the preview so you can iterate on templates without sending real mail. It warns when a template renders a data key your `testData` is missing (which would show as an empty section), and errors if the app has no `notifications:` section.
|
|
65
|
-
|
|
66
|
-
The preview tooling (`react-email`) is installed just-in-time by this command — it is never a dependency of your app or its production server.
|
|
67
|
-
|
|
68
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
69
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
70
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
71
|
-
- `--port <port>`: Change the port the email preview server is hosted at. The default is `3001`.
|
|
72
|
-
- `--ref-resolver <ref-resolver-function-path>`: Path to a JavaScript file containing a `_ref` resolver function to be used as the app default `_ref` resolver.
|
|
73
|
-
- `--server-directory <server-directory>`: Change the server directory, the directory in which the production server is placed. The default is `<config-directory>/.lowdefy/server`.
|
|
74
|
-
|
|
75
|
-
## agent-setup
|
|
76
|
-
|
|
77
|
-
The `agent-setup` command sets up a project for AI coding agents. It writes `.mcp.json` registering the dev server's [`lowdefy-docs` MCP endpoint](/ai-agent-docs), a Claude Code skill at `.claude/skills/lowdefy-config/SKILL.md`, and a `## Lowdefy` section in `AGENTS.md`. Existing files are merged, not overwritten.
|
|
78
|
-
|
|
79
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
80
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
81
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
82
|
-
- `--port <port>`: The port your dev server runs on, used in the generated URLs. The default is `3000`.
|
|
83
|
-
|
|
84
|
-
## init
|
|
85
|
-
|
|
86
|
-
The `init` command initializes a Lowdefy application. It creates the `lowdefy.yaml` and `.gitignore` in the working directory.
|
|
87
|
-
|
|
88
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
89
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
90
|
-
|
|
91
|
-
## init-docker
|
|
92
|
-
|
|
93
|
-
The `init-docker` command initializes a Dockerfile in the config directory that can be used to build a Docker image of the Lowdefy app.
|
|
94
|
-
|
|
95
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
96
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
97
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
98
|
-
|
|
99
|
-
## docker-output
|
|
100
|
-
|
|
101
|
-
The `docker-output` command assembles a minimal production runtime at `.lowdefy/docker` from an already-built app. It traces the server's runtime dependency graph and copies only the files the server actually imports, keeping the Docker image small. Run it after `lowdefy build`; the Dockerfile created by `init-docker` runs it for you.
|
|
102
|
-
|
|
103
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
104
|
-
- `--server-directory <server-directory>`: Change the server directory. The default is `.lowdefy/server` in the config directory.
|
|
105
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
106
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
107
|
-
|
|
108
|
-
## init-vercel
|
|
109
|
-
|
|
110
|
-
The `init-vercel` command initializes the installation scripts needed to deploy an app on [Vercel](https://vercel.com). It creates a directory called deploy, and a script called vercel.install.sh. It also creates a README file with instructions on how to configure Vercel.
|
|
111
|
-
|
|
112
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
113
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
114
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
115
|
-
|
|
116
|
-
## upgrade
|
|
117
|
-
|
|
118
|
-
The `upgrade` command upgrades a Lowdefy app to a newer version by walking you through migration prompts that handle breaking changes.
|
|
119
|
-
|
|
120
|
-
It fetches the latest `@lowdefy/codemods` package, resolves the version chain from your current version to the target, and presents migration prompts phase by phase.
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
pnpx lowdefy@5 upgrade
|
|
124
|
-
pnpx lowdefy@5 upgrade --to 6.0.0
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
- `--to <version>`: Target version to upgrade to. Defaults to the latest stable release.
|
|
128
|
-
- `--plan`: Show the upgrade plan without executing.
|
|
129
|
-
- `--resume`: Resume a previously interrupted upgrade.
|
|
130
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
131
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
132
|
-
|
|
133
|
-
### How it works
|
|
134
|
-
|
|
135
|
-
1. Reads your current version from `lowdefy.yaml`.
|
|
136
|
-
2. Queries npm for the latest stable Lowdefy version (or uses `--to`).
|
|
137
|
-
3. Fetches `@lowdefy/codemods@latest` — the codemods package containing all migration prompts.
|
|
138
|
-
4. Resolves the upgrade chain — which intermediate versions need codemods.
|
|
139
|
-
5. Presents migration prompts phase by phase. Each prompt can be copied to clipboard for use with any AI coding tool, viewed as a manual guide, or skipped for later.
|
|
140
|
-
6. Updates `lowdefy.yaml` after each phase and suggests a git commit.
|
|
141
|
-
|
|
142
|
-
See the [Upgrade Guide](/upgrade-guide) for more detail on how the upgrade system works.
|
|
143
|
-
|
|
144
|
-
## start
|
|
145
|
-
|
|
146
|
-
The `start` command starts a Lowdefy production server. To start a Lowdefy server, tha app should first be built using the `build` command.
|
|
147
|
-
|
|
148
|
-
- `--config-directory <config-directory>`: Change the config directory. The default is the current working directory.
|
|
149
|
-
- `--disable-telemetry`: Disable telemetry.
|
|
150
|
-
- `--log-level <level>`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
151
|
-
- `--port <port>`: Change the port the server is hosted at. The default is `3000`.
|
|
152
|
-
- `--server-directory <server-directory>`: Change the server directory, the directory in which the production server is placed. The default is `<config-directory>/.lowdefy/server`.
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
#### Examples
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
Run the dev server, watching a relative directory for file changes:
|
|
159
|
-
```txt
|
|
160
|
-
pnpx lowdefy@5 dev --watch ../other-project
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
Run the dev server, ignoring the public directory:
|
|
164
|
-
```txt
|
|
165
|
-
pnpx lowdefy@5 dev --watch-ignore public/**
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
# Module Fetching
|
|
171
|
-
|
|
172
|
-
When your app uses [modules](/modules), the build automatically fetches module sources during the build phase. GitHub modules are downloaded as tarballs and cached in `.lowdefy/modules/`. Multiple module entries from the same monorepo share a single cache entry. Local `file:` sources are read directly from disk.
|
|
173
|
-
|
|
174
|
-
For private GitHub repositories, set the `GITHUB_TOKEN` environment variable:
|
|
175
|
-
|
|
176
|
-
```
|
|
177
|
-
GITHUB_TOKEN=ghp_your_token_here
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
The CLI also checks for `gh` CLI credentials and git credential helpers as fallbacks.
|
|
181
|
-
|
|
182
|
-
In development mode (`lowdefy dev`), local module sources (`file:` paths) are watched for changes and trigger rebuilds automatically.
|
|
183
|
-
|
|
184
|
-
# Configuration
|
|
185
|
-
|
|
186
|
-
All the CLI options can either be set as command line options, or the `cli` config object in your `lowdefy.yaml` file. Options set as command line options take precedence over options set in the `lowdefy.yaml` file. The config in the `lowdefy.yaml` cannot be referenced using the `_ref` operator, but need to be set in the file itself.
|
|
187
|
-
|
|
188
|
-
Options set in the `lowdefy.yaml` should be defined in camelCase. The options that can be set are:
|
|
189
|
-
- `devDirectory: string`: Change the dev directory, the directory in which the development server is placed. The default is `<config-directory>/.lowdefy/dev`.
|
|
190
|
-
- `disableTelemetry: boolean`: Disable telemetry.
|
|
191
|
-
- `logLevel: enum`: The minimum severity of logs to show in the CLI output. Options are `debug`, `info`, `warn` or `error`. The default is `info`.
|
|
192
|
-
- `noOpen`: Do not open a new tab in the default browser.
|
|
193
|
-
- `port: number`: Change the port the server is hosted at. The default is `3000`.
|
|
194
|
-
- `refResolver: string`: Path to a JavaScript file containing a `_ref` resolver function to be used as the app default `_ref` resolver.
|
|
195
|
-
- `serverDirectory: string`: Change the server directory, the directory in which the production server is placed. The default is `<config-directory>/.lowdefy/server`.
|
|
196
|
-
- `watch: string[]`: A list of paths to files or directories that should be watched for changes.
|
|
197
|
-
- `watchIgnore: string[]`: A list of paths to files or directories that should be ignored by the file watcher. Globs are supported.
|
|
198
|
-
- `skipCodemodCheck: boolean`: Suppress warnings about pending codemod upgrades during build and dev.
|
|
199
|
-
|
|
200
|
-
The `--config-directory` option cannot be set from the `lowdefy.yaml` file.
|
|
201
|
-
|
|
202
|
-
# Telemetry
|
|
203
|
-
|
|
204
|
-
The CLI collects usage and error information to help us fix bugs, prioritize features, and understand how Lowdefy is being used.
|
|
205
|
-
|
|
206
|
-
All telemetry can be disabled by setting the `disableTelemetry` flag in `cli` config object in your `lowdefy.yaml` file (this cannot be a reference to another file), or by using the `--disable-telemetry` command line flag.:
|
|
207
|
-
|
|
208
|
-
###### `lowdefy.yaml`
|
|
209
|
-
```yaml
|
|
210
|
-
lowdefy: LOWDEFY_VERSION
|
|
211
|
-
|
|
212
|
-
cli:
|
|
213
|
-
disableTelemetry: true
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
We collect the following information:
|
|
217
|
-
|
|
218
|
-
- The CLI version.
|
|
219
|
-
- The Lowdefy version of your app.
|
|
220
|
-
- A random local app id (stored locally in your project folder at `.lowdefy/cli.json`).
|
|
221
|
-
- The CLI command used.
|
|
222
|
-
- Your IP address.
|
|
223
|
-
- Error messages and stack traces for any errors.
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Introduction
|
|
2
|
-
|
|
3
|
-
Lowdefy makes it really easy to build web apps. With Lowdefy you can build CRUD apps, admin panels, internal tools, BI dashboards, workflow apps, websites, blogs, webforms or even documentation pages such as this one.
|
|
4
|
-
|
|
5
|
-
Lowdefy apps are defined in YAML config that follows a structured schema - this makes Lowdefy apps easy to read, write and understand.
|
|
6
|
-
|
|
7
|
-
## Quickstart
|
|
8
|
-
|
|
9
|
-
Run the following command to initialize a new Lowdefy app in your current working directory.
|
|
10
|
-
|
|
11
|
-
$
|
|
12
|
-
|
|
13
|
-
pnpx lowdefy@5 init && pnpx lowdefy@5 dev
|
|
14
|
-
|
|
15
|
-
This will create a file called `lowdefy.yaml` in the current working directory that contains the configuration for a Lowdefy app (as well as a `.gitignore`) and launch a local development server at http://localhost:3000. Make changes in the `lowdefy.yaml` file to see them reflect in the app.
|
|
16
|
-
|
|
17
|
-
> You need Node v22 or newer and pnpm installed to run Lowdefy. For more details see [the tutorial](/tutorial-start).
|
|
18
|
-
|
|
19
|
-
## Why create web apps using a YAML schema?
|
|
20
|
-
|
|
21
|
-
The Lowdefy schema is a simple definition of a web app which primarily makes use of block, action, operator and request definitions.
|
|
22
|
-
|
|
23
|
-
Some advantages of writing web apps in YAML are:
|
|
24
|
-
- All apps use the same schema. This makes it easy to debug large apps or pick up where others left off.
|
|
25
|
-
- Nothing is hidden in a GUI. This allows you to do basic stuff, like copy, paste, find, replace etc. which makes developing apps more productive.
|
|
26
|
-
- App config is just data, thus you can develop scripts to create and manage your apps.
|
|
27
|
-
- YAML files work with your favorite developer and source control tools.
|
|
28
|
-
|
|
29
|
-
> If you aren't a fan of YAML, you can also build your app using JSON files.
|
|
30
|
-
|
|
31
|
-
## Build future proof web apps on an source available platform
|
|
32
|
-
|
|
33
|
-
To date, more than 25 000 apps have been built by the Lowdefy community. We hope to see many community Lowdefy apps and plugins in the future and actively nurture the Lowdefy community on [Github](https://github.com/lowdefy/lowdefy/discussions) and [Discord](https://discord.gg/QQY9eJ7A2D) to help other developers to get started with Lowdefy and grow the ecosystem.
|
|
34
|
-
|
|
35
|
-
We've built Lowdefy to scale our own ability to develop and maintain web apps and internal tools for customers. Currently, we also provide Custom Software as a Service for larger customers, as well as support plans for those who need some extra help. Using Lowdefy we've built ticketing systems, call center solutions, advanced CRMs, custom MRPs, surveys and BI dashboard solutions and more for startup to enterprise customers. If you are looking for a Custom Software as a Service partner, please [reach out to us](http://lowdefy.com/contact-us).
|
|
36
|
-
|
|
37
|
-
## Tutorial
|
|
38
|
-
|
|
39
|
-
The easiest way to get started with Lowdefy is to follow the tutorial. In this tutorial we will be building a simple Lowdefy app to get you started.
|
|
File without changes
|