CLI

• Getting Started
  • Getting Help
  • Enable Auto-completion
  • Dry Run
  • Paging
  • Output Format
  • Generate YAML Config
• Reference
  • peak images
    • peak images create
    • peak images create-version
    • peak images create-or-update
    • peak images list
    • peak images list-versions
    • peak images describe
    • peak images describe-version
    • peak images update-version
    • peak images delete
    • peak images delete-version
    • peak images delete-versions
    • peak images list-builds
    • peak images get-build-logs
  • peak metrics
    • peak metrics publish
    • peak metrics query
    • peak metrics list
    • peak metrics create-collection
    • peak metrics delete
    • peak metrics delete-collection
    • peak metrics list-collections
    • peak metrics list-namespaces
    • peak metrics update-namespace
  • peak alerts
    • peak alerts emails
      • peak alerts emails list
      • peak alerts emails send
      • peak alerts emails describe
      • peak alerts emails list-templates
      • peak alerts emails describe-template
  • peak artifacts
    • peak artifacts list
    • peak artifacts describe
    • peak artifacts delete
    • peak artifacts create
    • peak artifacts update-metadata
    • peak artifacts download
    • peak artifacts create-version
    • peak artifacts delete-version
  • peak cache
    • peak cache set
    • peak cache get
    • peak cache mget
    • peak cache mset
    • peak cache delete
    • peak cache exists
    • peak cache expire
    • peak cache ttl
    • peak cache ping
    • peak cache flush-pattern
    • peak cache flush-tenant
  • peak workflows
    • peak workflows create
    • peak workflows update
    • peak workflows create-or-update
    • peak workflows patch
    • peak workflows list
    • peak workflows describe
    • peak workflows pause
    • peak workflows resume
    • peak workflows delete
    • peak workflows execute
    • peak workflows list-resources
    • peak workflows list-default-resources
    • peak workflows list-executions
    • peak workflows get-execution-logs
    • peak workflows get-execution-details
  • peak webapps
    • peak webapps list
    • peak webapps create
    • peak webapps update
    • peak webapps create-or-update
    • peak webapps delete
    • peak webapps describe
  • peak services
    • peak services list
    • peak services create
    • peak services update
    • peak services create-or-update
    • peak services delete
    • peak services describe
    • peak services test
  • peak tenants
    • peak tenants list-instance-options
    • peak tenants get-credentials
  • peak apps
    • peak apps specs
      • peak apps specs create
      • peak apps specs list
      • peak apps specs describe
      • peak apps specs update-metadata
      • peak apps specs delete
      • peak apps specs create-release
      • peak apps specs describe-release
      • peak apps specs list-releases
    • peak apps deployments
      • peak apps deployments create
      • peak apps deployments list
      • peak apps deployments describe
      • peak apps deployments delete
      • peak apps deployments update-metadata
      • peak apps deployments redeploy
      • peak apps deployments create-revision
      • peak apps deployments describe-revision
      • peak apps deployments list-revisions
  • peak blocks
    • peak blocks specs
      • peak blocks specs list
      • peak blocks specs create
      • peak blocks specs describe
      • peak blocks specs update-metadata
      • peak blocks specs delete
      • peak blocks specs create-release
      • peak blocks specs describe-release
      • peak blocks specs list-releases
    • peak blocks deployments
      • peak blocks deployments create
      • peak blocks deployments list
      • peak blocks deployments describe
      • peak blocks deployments update-metadata
      • peak blocks deployments redeploy
      • peak blocks deployments delete
      • peak blocks deployments create-revision
      • peak blocks deployments describe-revision
      • peak blocks deployments list-revisions
      • peak blocks deployments get-parameters
      • peak blocks deployments patch-parameters
      • peak blocks deployments get-related-block-details
  • peak specs
    • peak specs list
    • peak specs list-release-deployments
  • peak deployments
    • peak deployments list
    • peak deployments execute-resources
    • peak deployments patch-parameters
    • peak deployments patch-parameters-v2
  • peak users
    • peak users check-permission
• Usage
  • Using Apps and Blocks
    • Defining CLI Parameters in App and Block Creation
    • Defining Markdown Content in App and Block Creation
    • Creating Resource Dependencies with Artifacts
    • Executing the resources of an app or block deployment
    • Interacting with Apps and Blocks
      • Press Apps
      • Press Blocks
  • Using Peak Resources
    • Defining Parameters in Resource Creation
    • Using a combination of command line options and yaml
    • Creating Resource Dependencies with Artifacts
    • Interacting with Peak resources
      • Cache
      • Email Notifications
      • Images
      • Services
      • Tenants
      • Users
      • Web Apps
      • Workflows
  • Using Peak Metrics
    • Publish metrics
    • Querying the published metrics
    • Create the metrics collection