Skip to main content

Command Summary

This page provides a comprehensive overview of all available commands in the platform CLI. Each command is designed to help you manage different aspects of your application development workflow.

Available Commands

CommandDescriptionCommon Usage
accessValidates the access token for publish and pull methodsEnsures proper authentication credentials for repository operations
add-formGenerates a new form in the selected menuCreates form components with optional wizard integration
application-reportsGenerates reports for all applicationsTracks and documents application changes and metadata
clean-remoteRemoves remotes added during operationsMaintains clean git repository by removing temporary connections
createCreates new application componentsInitializes new parts of your application
generateGenerates components from templatesAutomates creation of standardized code components
loginHandles user authenticationManages platform access credentials
package-major-updateManages major version updatesMaintains package dependencies
publishPublishes application changesHandles code deployment and version management
pullRetrieves latest changesKeeps local codebase in sync with remote repository
recordRecords application informationTracks modifications and maintains documentation
updateUpdates existing componentsManages application updates and modifications
versionDisplays CLI version informationTracks CLI tool version
wizardGenerates wizard stepsCreates and manages multi-step workflows

Usage Guidelines

  1. Before using any command that interacts with repositories (publish, pull), ensure you're properly authenticated using the access command.
  2. When creating new components, consider using the appropriate generator command to maintain consistency.
  3. Always review the changes before publishing them to the repository.
  4. Use the help flag (-h or --help) with any command to see detailed usage information.

Common Options

Most commands support the following options:

  • -h, --help: Display help information
  • -v, --version: Display version information (when applicable)
  • -f, --filter: Filter results (when applicable)

Best Practices

  1. Regularly clean up remote connections using the clean-remote command
  2. Use the wizard command for creating consistent multi-step workflows
  3. Generate reports periodically to track application changes
  4. Keep your local environment in sync using the pull command
  5. Validate access tokens before performing repository operations