Projects
Create, update, search and remove projects, and read the onboarding state of an instance. Generated from the `notploy` command surface.
Create, update, search and remove projects, and read the onboarding state of an instance.
notploy project exposes 11 commands. They map one-to-one onto the project.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy project --help to list these commands in your terminal, or
notploy project <command> --help for a single command.
Commands
notploy project all
Calls GET /api/trpc/project.all.
notploy project all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy project all-for-permissions
Calls GET /api/trpc/project.allForPermissions.
notploy project all-for-permissions [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy project complete-onboarding
Calls POST /api/trpc/project.completeOnboarding.
notploy project complete-onboarding [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy project create
Calls POST /api/trpc/project.create.
notploy project create --name <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--description <value> | string | No | — |
--env <value> | string | No | — |
--profile <name> | string | No | — |
notploy project duplicate
Calls POST /api/trpc/project.duplicate.
notploy project duplicate --sourceEnvironmentId <value> --name <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--sourceEnvironmentId <value> | string | Yes | — |
--name <value> | string | Yes | — |
--description <value> | string | No | — |
--includeServices [boolean] | boolean | No | — |
--no-includeServices | boolean | No | — |
--selectedServices <json> | array | No | — |
--duplicateInSameProject [boolean] | boolean | No | — |
--no-duplicateInSameProject | boolean | No | — |
--profile <name> | string | No | — |
notploy project home-stats
Calls GET /api/trpc/project.homeStats.
notploy project home-stats [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy project onboarding-status
Calls GET /api/trpc/project.onboardingStatus.
notploy project onboarding-status [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy project one
Calls GET /api/trpc/project.one.
notploy project one --projectId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--projectId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy project remove
Calls POST /api/trpc/project.remove.
notploy project remove --projectId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--projectId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy project search
Calls GET /api/trpc/project.search.
notploy project search [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--q <value> | string | No | — |
--name <value> | string | No | — |
--description <value> | string | No | — |
--limit <value> | number | No | — |
--offset <value> | number | No | — |
--profile <name> | string | No | — |
notploy project update
Calls POST /api/trpc/project.update.
notploy project update --projectId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--projectId <value> | string | Yes | — |
--name <value> | string | No | — |
--description <value> | string | No | — |
--createdAt <value> | string | No | — |
--organizationId <value> | string | No | — |
--env <value> | string | No | — |
--profile <name> | string | No | — |