Skip to content

Initialize a New Uplinkr Project

Terminal window
php artisan uplinkr:project:init

Initializes a new project and creates the necessary JSON-Data and stores it in the configured storage location.

OptionTypeRequiredDescription
--projectstringYesName of the project to initialize
--labelstringNoOptional project name/label
--descriptionstringNoOptional project description
--forceflagNoForce execution without confirmation
Terminal window
php artisan uplinkr:project:init --project=my-project
Terminal window
php artisan uplinkr:project:init \
--project=my-project \
--label="My Website" \
--description="Production website monitoring"
Terminal window
php artisan uplinkr:project:init --project=my-project --force
  • If the project already exists, you will be prompted for confirmation (unless --force is used)
  • Creates project structure in the configured storage location
  • Validates all required parameters before execution
  • 0 (SUCCESS): Project initialized successfully
  • 1 (INVALID): Validation failed or process was aborted