The command line (CLI) does what the connector does, from a terminal: check a module out and in, check it, deploy it, look at versions and submit it to the Marketplace. Most people use the Module Builder or their AI assistant; the CLI is for developers and for very large modules.
Install it and sign in
- Ask your AI assistant for the CLI setup steps (it has a setup tool for this), or ask Data Visions. You get a one-line install for your computer.
- Check it:
dv version. - Sign in:
dv dev connect --url <your-address>, using the address your setup steps give you (it can differ from one workspace to another). Type your password when it asks (if your AI assistant starts the sign-in for you, it opens a window for you to type it in), then check withdv dev status.
Check out and check in
- Check out:
dv modules checkout <code> [folder]. The code lands in a new folder that is a Git repository: you work onmain; the branchplatformholds the platform's copy. - Make your change and commit it with Git as you go.
- Check in:
dv modules checkin [folder] -m "what you changed". It becomes the next revision of the module's draft; preview and publish it in the Module Builder.
If someone checked in first, the check-in is refused. Run dv modules pull [folder] to bring in their changes and merge them with yours (commit your own first; Git marks any conflict for you to sort out), then check in again. See Several people changing one module.
The module commands
| Command | What it does |
|---|---|
dv modules checkout <code> [folder] | Takes a copy of the code to your computer. |
dv modules pull [folder] | Brings in the latest and merges it with your changes. |
dv modules checkin [folder] -m "..." | Sends your changes into the module's draft. |
dv modules checkouts [code] | Shows who has what checked out. |
dv modules validate <folder> | Checks the module's description and files. |
dv modules rules | Shows the eleven rules the module check reviews against. |
dv modules review <folder> | Runs the full module check without deploying. |
dv modules deploy <folder> | Deploys it to your workspace. Add --subscribe <your workspace> the first time. |
dv modules versions <code> | Lists its versions. |
dv modules publish <code> | Submits it to the Marketplace. |
Good to know
- You check out only modules your workspace owns, and deploy only to your own workspace.
- A check-in never goes live by itself. A deploy does, so use check-in when others are working on the same module.
- The version must go up. A deploy older than the live version is refused.
- Every command, and how to install and sign in: CLI command reference and Install and sign in to the CLI.