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
| Command | Description | Common Usage |
|---|---|---|
access | Validates the access token for publish and pull methods | Ensures proper authentication credentials for repository operations |
add-form | Generates a new form in the selected menu | Creates form components with optional wizard integration |
application-reports | Generates reports for all applications | Tracks and documents application changes and metadata |
clean-remote | Removes remotes added during operations | Maintains clean git repository by removing temporary connections |
create | Creates new application components | Initializes new parts of your application |
generate | Generates components from templates | Automates creation of standardized code components |
login | Handles user authentication | Manages platform access credentials |
package-major-update | Manages major version updates | Maintains package dependencies |
publish | Publishes application changes | Handles code deployment and version management |
pull | Retrieves latest changes | Keeps local codebase in sync with remote repository |
record | Records application information | Tracks modifications and maintains documentation |
update | Updates existing components | Manages application updates and modifications |
version | Displays CLI version information | Tracks CLI tool version |
wizard | Generates wizard steps | Creates and manages multi-step workflows |
Usage Guidelines
- Before using any command that interacts with repositories (publish, pull), ensure you're properly authenticated using the
accesscommand. - When creating new components, consider using the appropriate generator command to maintain consistency.
- Always review the changes before publishing them to the repository.
- 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
- Regularly clean up remote connections using the
clean-remotecommand - Use the wizard command for creating consistent multi-step workflows
- Generate reports periodically to track application changes
- Keep your local environment in sync using the pull command
- Validate access tokens before performing repository operations