@adpt/cli/oclif.manifest.json

AdaptJS command line interface

{"version":"0.3.1","commands":{"config:list":{"id":"config:list","description":"Shows Adapt configuration settings","pluginName":"@adpt/cli","pluginType":"core","aliases":[],"flags":{"all":{"name":"all","type":"boolean","description":"Show all configuration items, including defaults","allowNo":false},"source":{"name":"source","type":"boolean","description":"Show the source of each configuration item's value","allowNo":false},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false},"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false}},"args":[]},"config:set":{"id":"config:set","description":"Modify Adapt configuration settings","pluginName":"@adpt/cli","pluginType":"core","aliases":[],"examples":["Change the upgrade check notification to use the \"next\" channel:\n    $ adapt config:set upgradeChannel next"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false}},"args":[{"name":"name","description":"The name of the configuration item to be modified\n(not case-sensitive)","required":true},{"name":"value","description":"The value to assign to the configuration item","required":true}]},"deploy:destroy":{"id":"deploy:destroy","description":"Destroy an existing deployment of an Adapt project","pluginName":"@adpt/cli","pluginType":"core","aliases":["destroy"],"examples":["\nDestroy the deployment \"myproj-dev-abcd\" using the default project description file, \"index.tsx\":\n    $ adapt deploy:destroy myproj-dev-abcd"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"debug":{"name":"debug","type":"option","char":"d","description":"Enable additional debug output. Should be a comma-separated list of debug flags. Valid debug flags are: build","helpValue":"debugFlags","default":""},"serverUrl":{"name":"serverUrl","type":"option","description":"URL of Adapt server. Defaults to using local system."},"rootFile":{"name":"rootFile","type":"option","description":"Project description file to deploy (.ts or .tsx)","default":"index.tsx"},"dryRun":{"name":"dryRun","type":"boolean","description":"Show what would happen during deploy, but do not modify the deployment","allowNo":false},"registry":{"name":"registry","type":"option","description":"URL of alternate NPM registry to use"}},"args":[{"name":"deployID","required":true}]},"deploy:list":{"id":"deploy:list","description":"List active Adapt deployments","pluginName":"@adpt/cli","pluginType":"core","aliases":["list"],"examples":["List all deployments from the server\n    $ adapt deploy:list"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"debug":{"name":"debug","type":"option","char":"d","description":"Enable additional debug output. Should be a comma-separated list of debug flags. Valid debug flags are: build","helpValue":"debugFlags","default":""},"serverUrl":{"name":"serverUrl","type":"option","description":"URL of Adapt server. Defaults to using local system."},"rootFile":{"name":"rootFile","type":"option","description":"Project description file to deploy (.ts or .tsx)","default":"index.tsx"}},"args":[]},"deploy:run":{"id":"deploy:run","description":"Create a new deployment for an Adapt project","pluginName":"@adpt/cli","pluginType":"core","aliases":["run"],"examples":["Deploy the stack named \"default\" from the default project description file, index.tsx:\n    $ adapt <%- command.id %>\n","Deploy the stack named \"dev\" from the default project description file, index.tsx:\n    $ adapt <%- command.id %> dev\n","Deploy the stack named \"dev\" from an alternate description file:\n    $ adapt <%- command.id %> --rootFile somefile.tsx dev"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"debug":{"name":"debug","type":"option","char":"d","description":"Enable additional debug output. Should be a comma-separated list of debug flags. Valid debug flags are: build","helpValue":"debugFlags","default":""},"serverUrl":{"name":"serverUrl","type":"option","description":"URL of Adapt server. Defaults to using local system."},"rootFile":{"name":"rootFile","type":"option","description":"Project description file to deploy (.ts or .tsx)","default":"index.tsx"},"dryRun":{"name":"dryRun","type":"boolean","description":"Show what would happen during deploy, but do not modify the deployment","allowNo":false},"registry":{"name":"registry","type":"option","description":"URL of alternate NPM registry to use"},"deployID":{"name":"deployID","type":"option","description":"A fixed deployID to use for this deployment. Will error if the specified deployID already exists."}},"args":[{"name":"stackName","description":"Name of the stack you wish to run","default":"default"}]},"deploy:status":{"id":"deploy:status","description":"Fetch the status of an existing deployment of an Adapt project","pluginName":"@adpt/cli","pluginType":"core","aliases":["status"],"examples":["Fetch the status of deployment \"myproj-dev-abcd\" from the default project description file, \"index.tsx\":\n    $ adapt deploy:status myproj-dev-abcd\n","Fetch the status of deployment \"myproj-dev-abcd\" from an alternate description file, \"somefile.tsx\":\n    $ adapt deploy:status --rootFile somefile.tsx myproj-dev-abcd"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"debug":{"name":"debug","type":"option","char":"d","description":"Enable additional debug output. Should be a comma-separated list of debug flags. Valid debug flags are: build","helpValue":"debugFlags","default":""},"serverUrl":{"name":"serverUrl","type":"option","description":"URL of Adapt server. Defaults to using local system."},"rootFile":{"name":"rootFile","type":"option","description":"Project description file to deploy (.ts or .tsx)","default":"index.tsx"},"dryRun":{"name":"dryRun","type":"boolean","description":"Show what would happen during deploy, but do not modify the deployment","allowNo":false},"registry":{"name":"registry","type":"option","description":"URL of alternate NPM registry to use"}},"args":[{"name":"deployID","required":true}]},"deploy:update":{"id":"deploy:update","description":"Update an existing deployment of an Adapt project","pluginName":"@adpt/cli","pluginType":"core","aliases":["update"],"examples":["Update the deployment \"myproj-dev-abcd\", from the default project description file, \"index.tsx\":\n    $ adapt deploy:update myproj-dev-abcd\n","Update the deployment \"myproj-dev-abcd\", using the stack named \"dev\" from an alternate description file, \"somefile.tsx\":\n    $ adapt deploy:update --rootFile somefile.tsx myproj-dev-abcd dev"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"debug":{"name":"debug","type":"option","char":"d","description":"Enable additional debug output. Should be a comma-separated list of debug flags. Valid debug flags are: build","helpValue":"debugFlags","default":""},"serverUrl":{"name":"serverUrl","type":"option","description":"URL of Adapt server. Defaults to using local system."},"rootFile":{"name":"rootFile","type":"option","description":"Project description file to deploy (.ts or .tsx)","default":"index.tsx"},"dryRun":{"name":"dryRun","type":"boolean","description":"Show what would happen during deploy, but do not modify the deployment","allowNo":false},"registry":{"name":"registry","type":"option","description":"URL of alternate NPM registry to use"}},"args":[{"name":"deployID","required":true},{"name":"stackName"}]},"project:new":{"id":"project:new","description":"Create a new Adapt project","usage":["<%- command.id %> STARTER [DIRECTORY]","<%- command.id %> STARTER DIRECTORY [STARTER_ARGS...]"],"pluginName":"@adpt/cli","pluginType":"core","aliases":["new"],"examples":["Create a new project into the directory './myproj' using the starter named 'blank' from the Adapt starter gallery:\n    $ adapt <%- command.id %> blank myproj"],"flags":{"quiet":{"name":"quiet","type":"boolean","char":"q","description":"Suppress status output messages. Still outputs any result output.","allowNo":false},"adaptVersion":{"name":"adaptVersion","type":"option","description":"[default: <adapt CLI version>] Attempt to select a starter that is compatible with this version of Adapt. Must be a valid semver."},"sshHostKeyCheck":{"name":"sshHostKeyCheck","type":"option","description":"Sets the ssh StrictHostKeyChecking option when using the ssh protocol for fetching a starter from a remote git repository. Defaults to 'yes' if OpenSSH is detected, 'unset' otherwise.","options":["yes","no","ask","accept-new","off","unset"],"default":"yes"}},"args":[{"name":"starter","description":"Adapt starter to use. May be the name of a starter from the starter gallery, a URL, a local file path, or most formats supported by npm.","required":true},{"name":"directory","description":"Directory where the new project should be created. The directory will be created if it does not exist.","default":"."}]}}}