bdy 1.16.29-dev → 1.16.30-dev

package/distTs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.16.29-dev",
+  "version": "1.16.30-dev",
   "type": "commonjs",
   "license": "MIT",
   "scripts": {

package/distTs/src/command/package/create.js

@@ -20,6 +20,7 @@ commandPackageCreate.option('-t, --type <type>', texts_1.OPT_COMMAND_PACKAGE_TYP
 commandPackageCreate.option('-b, --buddy', texts_1.OPTION_HTTP_AUTH_BUDDY);
 commandPackageCreate.option('-a, --auth <user:pass>', texts_1.OPTION_HTTP_AUTH);
 commandPackageCreate.argument('[name]', texts_1.OPT_COMMAND_PACKAGE_NAME);
+commandPackageCreate.addHelpText('after', texts_1.EXAMPLE_PACKAGE_CREATE);
 commandPackageCreate.action(async (name, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project, true);

package/distTs/src/command/package/delete.js

@@ -15,6 +15,7 @@ commandPackageDelete.option('--region <region>', texts_1.OPTION_REST_API_REGION)
 commandPackageDelete.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandPackageDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandPackageDelete.argument('<identifier>', texts_1.OPT_COMMAND_PACKAGE_IDENTIFIER);
+commandPackageDelete.addHelpText('after', texts_1.EXAMPLE_PACKAGE_DELETE);
 commandPackageDelete.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const client = input_1.default.restApiTokenClient(options.api, options.region, options.token);
@@ -25,7 +26,8 @@ commandPackageDelete.action(async (identifier, options) => {
     if (!data.pkg_id) {
         output_1.default.exitError(texts_1.ERR_PACKAGE_NOT_FOUND);
     }
-    const confirmed = options.force || await output_1.default.confirm((0, texts_1.TXT_PACKAGE_DELETE_CONFIRM)(identifier));
+    const confirmed = options.force ||
+        (await output_1.default.confirm((0, texts_1.TXT_PACKAGE_DELETE_CONFIRM)(identifier)));
     if (confirmed) {
         await client.deletePackage(workspace, data.pkg_id);
         output_1.default.exitSuccess(texts_1.TXT_PACKAGE_DELETED);

package/distTs/src/command/package/download.js

@@ -23,6 +23,7 @@ commandPackageDownload.option('-m, --merge', texts_1.OPTION_PACKAGE_DOWNLOAD_MER
 commandPackageDownload.option('-r, --replace', texts_1.OPTION_PACKAGE_DOWNLOAD_REPLACE);
 commandPackageDownload.argument('<identifier>', texts_1.OPTION_PACKAGE_ID);
 commandPackageDownload.argument('<directory>', texts_1.OPTION_PACKAGE_DOWNLOAD_PATH);
+commandPackageDownload.addHelpText('after', texts_1.EXAMPLE_PACKAGE_DOWNLOAD);
 commandPackageDownload.action(async (id, path, options) => {
     const client = input_1.default.restApiTokenClient(options.api, options.region, options.token);
     const workspace = input_1.default.restApiWorkspace(options.workspace);

package/distTs/src/command/package/publish.js

@@ -23,6 +23,7 @@ commandPackagePublish.option('-c, --create', texts_1.OPTION_PACKAGE_PUBLISH_CREA
 commandPackagePublish.option('-f, --force', texts_1.OPTION_PACKAGE_PUBLISH_OVERWRITE_VERSION);
 commandPackagePublish.argument('<identifier>', texts_1.OPTION_PACKAGE_ID);
 commandPackagePublish.argument('<directory>', texts_1.OPTION_PACKAGE_PUBLISH_PATH);
+commandPackagePublish.addHelpText('after', texts_1.EXAMPLE_PACKAGE_PUBLISH);
 commandPackagePublish.action(async (id, path, options) => {
     let dirPath = input_1.default.resolvePath(path);
     const workspace = input_1.default.restApiWorkspace(options.workspace);
@@ -48,13 +49,13 @@ commandPackagePublish.action(async (id, path, options) => {
                 type: utils_1.PACKAGE_TYPE.FILE,
                 scope: utils_1.PACKAGE_SCOPE.WORKSPACE,
                 authorization: {
-                    type: utils_1.PACKAGE_AUTH_TYPE.BUDDY
-                }
+                    type: utils_1.PACKAGE_AUTH_TYPE.BUDDY,
+                },
             };
             if (project) {
                 data.scope = utils_1.PACKAGE_SCOPE.PROJECT;
                 data.project = {
-                    name: project
+                    name: project,
                 };
             }
             const d = await client.postPackage(workspace, data);

package/distTs/src/command/package/version/delete.js

@@ -17,6 +17,7 @@ commandPackageVersionDelete.option('-p, --project <name>', texts_1.OPTION_REST_A
 commandPackageVersionDelete.argument('<identifier>', texts_1.OPT_COMMAND_PACKAGE_IDENTIFIER);
 commandPackageVersionDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandPackageVersionDelete.argument('<version>', texts_1.OPT_COMMAND_PACKAGE_VERSION);
+commandPackageVersionDelete.addHelpText('after', texts_1.EXAMPLE_PACKAGE_VERSION_DELETE);
 commandPackageVersionDelete.action(async (identifier, version, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project, true);

package/distTs/src/command/package/version/get.js

@@ -15,6 +15,7 @@ commandPackageVersionGet.option('-w, --workspace <domain>', texts_1.OPTION_REST_
 commandPackageVersionGet.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandPackageVersionGet.argument('<identifier>', texts_1.OPT_COMMAND_PACKAGE_IDENTIFIER);
 commandPackageVersionGet.argument('<version>', texts_1.OPT_COMMAND_PACKAGE_VERSION);
+commandPackageVersionGet.addHelpText('after', texts_1.EXAMPLE_PACKAGE_VERSION_GET);
 commandPackageVersionGet.action(async (identifier, version, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project, true);

package/distTs/src/command/package/version/list.js

@@ -17,6 +17,7 @@ commandPackageVersionList.option('--page <number>', texts_1.OPTION_REST_API_PAGE
 commandPackageVersionList.option('--per-page <number>', texts_1.OPTION_REST_API_PER_PAGE, '10');
 commandPackageVersionList.alias('ls');
 commandPackageVersionList.argument('<identifier>', texts_1.OPT_COMMAND_PACKAGE_IDENTIFIER);
+commandPackageVersionList.addHelpText('after', texts_1.EXAMPLE_PACKAGE_VERSION_LIST);
 commandPackageVersionList.action(async (identifier, options) => {
     const page = input_1.default.restApiPage(options.page);
     const perPage = input_1.default.restApiPerPage(options.perPage);

package/distTs/src/command/pipeline/run.js

@@ -29,6 +29,7 @@ commandPipelineRun.option('--action <actions...>', texts_1.OPTION_PIPELINE_RUN_A
 commandPipelineRun.option('--wait [minutes]', texts_1.OPTION_PIPELINE_RUN_WAIT);
 commandPipelineRun.argument('<identifier>', texts_1.OPTION_PIPELINE_RUN_ARGUMENT);
 commandPipelineRun.usage('<identifier> [options]');
+commandPipelineRun.addHelpText('after', texts_1.EXAMPLE_PIPELINE_RUN);
 commandPipelineRun.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/cp.js

@@ -22,6 +22,7 @@ commandSandboxCp.option('-m, --merge', texts_1.OPTION_SANDBOX_CP_DOWNLOAD_MERGE)
 commandSandboxCp.option('-r, --replace', texts_1.OPTION_SANDBOX_CP_DOWNLOAD_REPLACE);
 commandSandboxCp.argument('<source>', texts_1.OPTION_SANDBOX_CP_SOURCE);
 commandSandboxCp.argument('<destination>', texts_1.OPTION_SANDBOX_CP_DEST);
+commandSandboxCp.addHelpText('after', texts_1.EXAMPLE_SANDBOX_CP);
 const upload = async (client, workspace, project, source, destination) => {
     const { sourcePath, sourceStats } = input_1.default.restApiSandboxUploadSourcePath(source);
     const { identifier, remotePath } = input_1.default.restApiSandboxUploadDestinationPath(destination);

package/distTs/src/command/sandbox/create.js

@@ -41,6 +41,7 @@ commandSandboxCreate.option('--app-type <type>', texts_1.OPTION_SANDBOX_APP_TYPE
 commandSandboxCreate.option('--tag <tags...>', texts_1.OPTION_SANDBOX_TAGS);
 commandSandboxCreate.option('--wait-for-running [seconds]', texts_1.OPTION_SANDBOX_WAIT_RUNNING);
 commandSandboxCreate.option('--wait-for-configured [seconds]', texts_1.OPTION_SANDBOX_WAIT_CONFIGURED);
+commandSandboxCreate.addHelpText('after', texts_1.EXAMPLE_SANDBOX_CREATE);
 commandSandboxCreate.action(async (options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/endpoint/add.js

@@ -10,6 +10,7 @@ const input_1 = __importDefault(require("../../../input"));
 const logger_1 = __importDefault(require("../../../logger"));
 const commandSandboxEndpointAdd = (0, utils_1.getBasicCommandSandboxEndpoint)('add', texts_1.DESC_COMMAND_SANDBOX_ENDPOINT_ADD);
 commandSandboxEndpointAdd.alias('create');
+commandSandboxEndpointAdd.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_ENDPOINT_CREATE}`);
 commandSandboxEndpointAdd.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/endpoint/delete.js

@@ -17,6 +17,7 @@ commandSandboxEndpointDelete.option('-p, --project <name>', texts_1.OPTION_REST_
 commandSandboxEndpointDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandSandboxEndpointDelete.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxEndpointDelete.argument('<endpoint-name>', texts_1.OPTION_SANDBOX_ENDPOINT_NAME_ARG);
+commandSandboxEndpointDelete.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_ENDPOINT_DELETE}`);
 commandSandboxEndpointDelete.action(async (identifier, endpointName, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/endpoint/get.js

@@ -15,6 +15,7 @@ commandSandboxEndpointGet.option('-w, --workspace <domain>', texts_1.OPTION_REST
 commandSandboxEndpointGet.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxEndpointGet.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxEndpointGet.argument('<endpoint-name>', texts_1.OPTION_SANDBOX_ENDPOINT_NAME_ARG);
+commandSandboxEndpointGet.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_ENDPOINT_GET}`);
 commandSandboxEndpointGet.action(async (identifier, endpointName, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/endpoint/list.js

@@ -15,6 +15,7 @@ commandSandboxEndpointList.option('--region <region>', texts_1.OPTION_REST_API_R
 commandSandboxEndpointList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandSandboxEndpointList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxEndpointList.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxEndpointList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_ENDPOINT_LIST}`);
 commandSandboxEndpointList.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/endpoint.js

@@ -15,4 +15,8 @@ commandSandboxEndpoint.addCommand(list_1.default);
 commandSandboxEndpoint.addCommand(get_1.default);
 commandSandboxEndpoint.addCommand(add_1.default);
 commandSandboxEndpoint.addCommand(delete_1.default);
+commandSandboxEndpoint.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_ENDPOINT_CREATE}
+${texts_1.EXAMPLE_SANDBOX_ENDPOINT_DELETE}
+${texts_1.EXAMPLE_SANDBOX_ENDPOINT_GET}
+${texts_1.EXAMPLE_SANDBOX_ENDPOINT_LIST}`);
 exports.default = commandSandboxEndpoint;

package/distTs/src/command/sandbox/exec/command.js

@@ -18,6 +18,7 @@ commandSandboxExecCommand.option('--runtime <runtime>', texts_1.OPTION_SANDBOX_R
 commandSandboxExecCommand.option('--wait', texts_1.OPTION_SANDBOX_WAIT);
 commandSandboxExecCommand.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxExecCommand.argument('<command>');
+commandSandboxExecCommand.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_COMMAND}`);
 commandSandboxExecCommand.action(async (identifier, command, options) => {
     output_1.default.handleSignals();
     const workspace = input_1.default.restApiWorkspace(options.workspace);

package/distTs/src/command/sandbox/exec/kill.js

@@ -16,6 +16,7 @@ commandSandboxExecKill.option('-p, --project <name>', texts_1.OPTION_REST_API_PR
 commandSandboxExecKill.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandSandboxExecKill.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxExecKill.argument('<command-id>', texts_1.OPTION_SANDBOX_COMMAND_ID);
+commandSandboxExecKill.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_KILL}`);
 commandSandboxExecKill.action(async (identifier, commandId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/exec/list.js

@@ -15,6 +15,7 @@ commandSandboxExecList.option('--region <region>', texts_1.OPTION_REST_API_REGIO
 commandSandboxExecList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandSandboxExecList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxExecList.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxExecList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_LIST}`);
 commandSandboxExecList.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/exec/logs.js

@@ -16,6 +16,7 @@ commandSandboxExecLogs.option('-p, --project <name>', texts_1.OPTION_REST_API_PR
 commandSandboxExecLogs.option('--wait', texts_1.OPTION_SANDBOX_WAIT);
 commandSandboxExecLogs.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxExecLogs.argument('<command-id>', texts_1.OPTION_SANDBOX_COMMAND_ID);
+commandSandboxExecLogs.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_LOGS}`);
 commandSandboxExecLogs.action(async (identifier, commandId, options) => {
     output_1.default.handleSignals();
     const workspace = input_1.default.restApiWorkspace(options.workspace);

package/distTs/src/command/sandbox/exec/status.js

@@ -15,6 +15,7 @@ commandSandboxExecStatus.option('-w, --workspace <domain>', texts_1.OPTION_REST_
 commandSandboxExecStatus.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxExecStatus.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxExecStatus.argument('<command-id>', texts_1.OPTION_SANDBOX_COMMAND_ID);
+commandSandboxExecStatus.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_STATUS}`);
 commandSandboxExecStatus.action(async (identifier, commandId, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/exec.js

@@ -16,4 +16,9 @@ commandSandboxExec.addCommand(status_1.default);
 commandSandboxExec.addCommand(kill_1.default);
 commandSandboxExec.addCommand(list_1.default);
 commandSandboxExec.addCommand(logs_1.default);
+commandSandboxExec.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_EXEC_COMMAND}
+${texts_1.EXAMPLE_SANDBOX_EXEC_KILL}
+${texts_1.EXAMPLE_SANDBOX_EXEC_LIST}
+${texts_1.EXAMPLE_SANDBOX_EXEC_LOGS}
+${texts_1.EXAMPLE_SANDBOX_EXEC_STATUS}`);
 exports.default = commandSandboxExec;

package/distTs/src/command/sandbox/snapshot/create.js

@@ -18,6 +18,7 @@ commandSandboxSnapshotCreate.option('-p, --project <name>', texts_1.OPTION_REST_
 commandSandboxSnapshotCreate.option('-n, --name <name>', texts_1.OPTION_SANDBOX_SNAPSHOT_NAME);
 commandSandboxSnapshotCreate.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxSnapshotCreate.option('--wait [seconds]', texts_1.OPTION_SANDBOX_WAIT);
+commandSandboxSnapshotCreate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_CREATE}`);
 commandSandboxSnapshotCreate.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/snapshot/delete.js

@@ -17,6 +17,7 @@ commandSandboxSnapshotDelete.option('-p, --project <name>', texts_1.OPTION_REST_
 commandSandboxSnapshotDelete.option('-f, --force', texts_1.OPTION_CONFIRM_FORCE);
 commandSandboxSnapshotDelete.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxSnapshotDelete.argument('<snapshot-name>', texts_1.OPTION_SANDBOX_SNAPSHOT_NAME_ARG);
+commandSandboxSnapshotDelete.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_DELETE}`);
 commandSandboxSnapshotDelete.action(async (identifier, snapshotName, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/snapshot/get.js

@@ -15,6 +15,7 @@ commandSandboxSnapshotGet.option('-w, --workspace <domain>', texts_1.OPTION_REST
 commandSandboxSnapshotGet.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxSnapshotGet.argument('<identifier>', texts_1.OPTION_SANDBOX_IDENTIFIER);
 commandSandboxSnapshotGet.argument('<snapshot-name>', texts_1.OPTION_SANDBOX_SNAPSHOT_NAME_ARG);
+commandSandboxSnapshotGet.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_GET}`);
 commandSandboxSnapshotGet.action(async (identifier, snapshotName, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);

package/distTs/src/command/sandbox/snapshot/list.js

@@ -15,6 +15,7 @@ commandSandboxSnapshotList.option('--region <region>', texts_1.OPTION_REST_API_R
 commandSandboxSnapshotList.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
 commandSandboxSnapshotList.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
 commandSandboxSnapshotList.argument('[identifier]', texts_1.OPTION_SANDBOX_IDENTIFIER);
+commandSandboxSnapshotList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_LIST}`);
 commandSandboxSnapshotList.action(async (identifier, options) => {
     const workspace = input_1.default.restApiWorkspace(options.workspace);
     const project = input_1.default.restApiProject(options.project);
@@ -43,7 +44,7 @@ commandSandboxSnapshotList.action(async (identifier, options) => {
             snapshot.name || '-',
             snapshot.status || '-',
             snapshot.create_date || '-',
-            snapshot.html_url || '-'
+            snapshot.html_url || '-',
         ]);
     }
     output_1.default.table(data);

package/distTs/src/command/sandbox/snapshot.js

@@ -15,4 +15,8 @@ commandSandboxSnapshot.addCommand(list_1.default);
 commandSandboxSnapshot.addCommand(create_1.default);
 commandSandboxSnapshot.addCommand(get_1.default);
 commandSandboxSnapshot.addCommand(delete_1.default);
+commandSandboxSnapshot.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_CREATE}
+${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_DELETE}
+${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_GET}
+${texts_1.EXAMPLE_SANDBOX_SNAPSHOT_LIST}`);
 exports.default = commandSandboxSnapshot;

package/distTs/src/texts.js

@@ -11,7 +11,7 @@ exports.DESC_COMMAND_SANDBOX_LIST = exports.DESC_COMMAND_SANDBOX_CREATE = export
 exports.DESC_COMMAND_SANDBOX_SNAPSHOT_CREATE = exports.DESC_COMMAND_SANDBOX_SNAPSHOT_LIST = exports.DESC_COMMAND_SANDBOX_SNAPSHOT = exports.TXT_SANDBOX_COMMAND_KILLED = exports.OPTION_SANDBOX_COMMAND_KILL_CONFIRM = exports.OPTION_SANDBOX_COMMAND_ID = exports.DESC_COMMAND_SANDBOX_EXEC_KILL = exports.DESC_COMMAND_SANDBOX_EXEC_LOGS = exports.DESC_COMMAND_SANDBOX_EXEC_STATUS = exports.DESC_COMMAND_SANDBOX_EXEC_LIST = exports.TXT_SANDBOX_WAITING_START = exports.TXT_SANDBOX_WAITING_STOP = exports.TXT_SANDBOX_WAITING_SETUP = exports.TXT_SANDBOX_WAITING_RUNNING = exports.TXT_SANDBOX_STOPPED = exports.TXT_SANDBOX_STARTED = exports.TXT_SANDBOX_DESTROYED = exports.TXT_SANDBOX_DESTROY_CONFIRM = exports.TXT_SANDBOX_CREATED = exports.TXT_SANDBOX_CREATING = exports.OPTION_SANDBOX_WAIT = exports.OPTION_SANDBOX_WAIT_CONFIGURED = exports.OPTION_SANDBOX_WAIT_RUNNING = exports.ERR_SANDBOX_STOP_FAILED = exports.ERR_SANDBOX_NO_COMMANDS = exports.ERR_SANDBOX_RUNNING_FAILED = exports.ERR_SANDBOX_STOP_TIMEOUT = exports.ERR_SANDBOX_SNAPSHOT_TIMEOUT = exports.ERR_SANDBOX_RUNNING_TIMEOUT = exports.ERR_SANDBOX_SETUP_TIMEOUT = exports.ERR_SANDBOX_SETUP_FAILED = exports.ERR_SANDBOX_INVALID_RESOURCES = exports.ERR_SANDBOX_NOT_FOUND = exports.OPTION_SANDBOX_RUNTIME = exports.OPTION_SANDBOX_APP_TYPE = exports.OPTION_SANDBOX_APP_DIR = exports.OPTION_SANDBOX_RUN_COMMAND = exports.OPTION_SANDBOX_TAGS = exports.OPTION_SANDBOX_INSTALL_COMMANDS = exports.OPTION_SANDBOX_RESOURCES = exports.OPTION_SANDBOX_OS = exports.OPTION_SANDBOX_NAME = exports.OPTION_SANDBOX_IDENTIFIER = exports.DESC_COMMAND_SANDBOX_EXEC = exports.DESC_COMMAND_SANDBOX_STATUS = exports.DESC_COMMAND_SANDBOX_RESTART = exports.DESC_COMMAND_SANDBOX_STOP = exports.DESC_COMMAND_SANDBOX_START = exports.DESC_COMMAND_SANDBOX_DESTROY = exports.DESC_COMMAND_SANDBOX_GET = void 0;
 exports.TXT_SANDBOX_EXEC_SUCCESS = exports.TXT_SANDBOX_EXEC_BACKGROUND = exports.TXT_SANDBOX_EXEC_ID = exports.ERR_SANDBOX_CP_INVALID_SOURCE = exports.ERR_SANDBOX_CP_INVALID_DEST = exports.ERR_SANDBOX_CP_REPLACE = exports.ERR_SANDBOX_CP_MKDIR = exports.ERR_SANDBOX_CP_NOT_EMPTY_DIR = exports.ERR_SANDBOX_CP_READDIR = exports.ERR_SANDBOX_CP_DEST_NOT_FOLDER = exports.ERR_SANDBOX_CP_SOURCE_NOT_FOUND = exports.TXT_SANDBOX_CP_DONE = exports.TXT_SANDBOX_CP_PROGRESS = exports.TXT_SANDBOX_UNZIPPING_COUNT = exports.TXT_SANDBOX_UNZIP_DONE = exports.TXT_SANDBOX_UNZIP = exports.TXT_SANDBOX_CP_DOWNLOAD_DONE = exports.TXT_SANDBOX_CP_DOWNLOAD = exports.OPTION_SANDBOX_CP_DOWNLOAD_REPLACE = exports.OPTION_SANDBOX_CP_DOWNLOAD_MERGE = exports.OPTION_SANDBOX_CP_DEST = exports.OPTION_SANDBOX_CP_SOURCE = exports.DESC_COMMAND_SANDBOX_CP = exports.ERR_SANDBOX_ENDPOINTS_NOT_FOUND = exports.ERR_SANDBOX_ENDPOINT_NOT_FOUND = exports.ERR_SANDBOX_ENDPOINT_EXISTS = exports.TXT_SANDBOX_ENDPOINT_DELETED = exports.TXT_SANDBOX_ENDPOINT_DELETE_CONFIRM = exports.TXT_SANDBOX_ENDPOINT_ADDED = exports.OPTION_SANDBOX_ENDPOINT_TYPE = exports.OPTION_SANDBOX_ENDPOINT_PORT = exports.OPTION_SANDBOX_ENDPOINT_NAME_ARG = exports.OPTION_SANDBOX_ENDPOINT_NAME = exports.DESC_COMMAND_SANDBOX_ENDPOINT_DELETE = exports.DESC_COMMAND_SANDBOX_ENDPOINT_ADD = exports.DESC_COMMAND_SANDBOX_ENDPOINT_GET = exports.DESC_COMMAND_SANDBOX_ENDPOINT_LIST = exports.DESC_COMMAND_SANDBOX_ENDPOINT = exports.ERR_SANDBOX_SNAPSHOTS_NOT_FOUND = exports.ERR_SANDBOX_SNAPSHOT_NOT_FOUND = exports.ERR_SANDBOX_SNAPSHOT_FAILED = exports.TXT_SANDBOX_SNAPSHOT_WAITING = exports.TXT_SANDBOX_SNAPSHOT_DELETE_CONFIRM = exports.TXT_SANDBOX_SNAPSHOT_DELETED = exports.TXT_SANDBOX_SNAPSHOT_CREATED = exports.OPTION_SANDBOX_FROM_SNAPSHOT = exports.OPTION_SANDBOX_SNAPSHOT_NAME_ARG = exports.OPTION_SANDBOX_SNAPSHOT_NAME = exports.DESC_COMMAND_SANDBOX_SNAPSHOT_DELETE = exports.DESC_COMMAND_SANDBOX_SNAPSHOT_GET = void 0;
 exports.TXT_PACKAGE_DELETED = exports.ERR_COMMAND_PACKAGE_TYPE = exports.OPT_COMMAND_PACKAGE_VERSION = exports.OPT_COMMAND_PACKAGE_IDENTIFIER = exports.OPT_COMMAND_PACKAGE_CREATE_IDENTIFIER = exports.OPT_COMMAND_PACKAGE_NAME = exports.OPT_COMMAND_PACKAGE_TYPE = exports.DESC_COMMAND_PACKAGE_CREATE = exports.DESC_COMMAND_PACKAGE_GET = exports.TXT_PACKAGE_DOCKER_LOGIN_FAILED = exports.TXT_PACKAGE_DOCKER_LOGIN_SUCCESS = exports.TXT_PACKAGE_VERSION_DELETE_CONFIRM = exports.TXT_PACKAGE_DELETE_CONFIRM = exports.DESC_COMMAND_PACKAGE_DELETE = exports.ERR_COMMAND_PACKAGE_NO_PROJECTS = exports.DESC_COMMAND_PACKAGE_VERSION_GET = exports.DESC_COMMAND_PACKAGE_VERSION_LIST = exports.DESC_COMMAND_PACKAGE_VERSION_DELETE = exports.DESC_COMMAND_PACKAGE_DOCKER_LOGIN = exports.DESC_COMMAND_PACKAGE_LIST = exports.DESC_COMMAND_PACKAGE_VERSION = exports.ERR_API_MESSAGE_REPLACER = exports.ERR_LOGIN_INVALID_BASE_URL = exports.ERR_LOGIN_NO_PROJECT_FOUND = exports.ERR_LOGIN_NO_WORKSPACE_FOUND = exports.ERR_LOGIN_NO_WORKSPACES = exports.ERR_LOGIN_HTTP_SUCCESS = exports.ERR_LOGIN_HTTP_FAILED = exports.TXT_LOGIN_OAUTH = exports.ERR_LOGIN_HTTP_SERVER_PORT_TAKEN = exports.TXT_LOGIN_SUCCESS = exports.TXT_LOGIN_SELECT_WORKSPACE = exports.TXT_LOGIN_ENTER_BASE_URL = exports.TXT_LOGIN_SELECT_REGION = exports.TXT_WORKSPACE_NONE = exports.TXT_WORKSPACE_SET_SUCCESS = exports.ARG_COMMAND_WORKSPACE = exports.DESC_COMMAND_WORKSPACE_GET = exports.DESC_COMMAND_WORKSPACE_SET = exports.DESC_COMMAND_WORKSPACE_LIST = exports.DESC_COMMAND_WORKSPACE = exports.TXT_LOGOUT_SUCCESS = exports.DESC_COMMAND_LOGOUT = exports.DESC_COMMAND_LOGIN = exports.ERR_WHOAMI_LOGOUT = exports.TXT_WHOAMI_NO_PROJECT = exports.TXT_WHOAMI_NO_WORKSPACE = exports.DESC_COMMAND_WHOAMI = exports.TXT_SANDBOX_EXEC_FAILED = exports.TXT_SANDBOX_EXEC_INPROGRESS = void 0;
-exports.TXT_PROJECT_NONE = exports.ERR_PROJECT_NO_PROJECTS = exports.TXT_LOGIN_SELECT_PROJECT = exports.TXT_PROJECT_SET_CLEARED = exports.TXT_PROJECT_SET_SUCCESS = exports.DESC_COMMAND_PROJECT_GET = exports.ARG_COMMAND_PROJECT_NAME = exports.DESC_COMMAND_PROJECT_SET = exports.DESC_COMMAND_PROJECT_LIST = exports.DESC_COMMAND_PROJECT = exports.TXT_PACKAGE_VERSION_DOWNLOAD = exports.TXT_PACKAGE_PUBLISH = exports.TXT_PACKAGE_CREATED = exports.TXT_PACKAGE_VERSION_DELETED = void 0;
+exports.EXAMPLE_PACKAGE_VERSION_DELETE = exports.EXAMPLE_PACKAGE_VERSION_GET = exports.EXAMPLE_PACKAGE_VERSION_LIST = exports.EXAMPLE_PACKAGE_CREATE = exports.EXAMPLE_PACKAGE_DELETE = exports.EXAMPLE_PACKAGE_DOWNLOAD = exports.EXAMPLE_PACKAGE_PUBLISH = exports.EXAMPLE_PIPELINE_RUN = exports.EXAMPLE_SANDBOX_ENDPOINT_LIST = exports.EXAMPLE_SANDBOX_ENDPOINT_GET = exports.EXAMPLE_SANDBOX_ENDPOINT_DELETE = exports.EXAMPLE_SANDBOX_ENDPOINT_CREATE = exports.EXAMPLE_SANDBOX_SNAPSHOT_LIST = exports.EXAMPLE_SANDBOX_SNAPSHOT_GET = exports.EXAMPLE_SANDBOX_SNAPSHOT_DELETE = exports.EXAMPLE_SANDBOX_SNAPSHOT_CREATE = exports.EXAMPLE_SANDBOX_EXEC_STATUS = exports.EXAMPLE_SANDBOX_EXEC_LOGS = exports.EXAMPLE_SANDBOX_EXEC_LIST = exports.EXAMPLE_SANDBOX_EXEC_KILL = exports.EXAMPLE_SANDBOX_EXEC_COMMAND = exports.EXAMPLE_SANDBOX_CREATE = exports.EXAMPLE_SANDBOX_CP = exports.TXT_PROJECT_NONE = exports.ERR_PROJECT_NO_PROJECTS = exports.TXT_LOGIN_SELECT_PROJECT = exports.TXT_PROJECT_SET_CLEARED = exports.TXT_PROJECT_SET_SUCCESS = exports.DESC_COMMAND_PROJECT_GET = exports.ARG_COMMAND_PROJECT_NAME = exports.DESC_COMMAND_PROJECT_SET = exports.DESC_COMMAND_PROJECT_LIST = exports.DESC_COMMAND_PROJECT = exports.TXT_PACKAGE_VERSION_DOWNLOAD = exports.TXT_PACKAGE_PUBLISH = exports.TXT_PACKAGE_CREATED = exports.TXT_PACKAGE_VERSION_DELETED = void 0;
 const utils_1 = require("./utils");
 exports.ERR_REST_API_GENERAL_ERROR = 'Something went wrong';
 exports.ERR_REST_API_NOT_RESPONDING = 'Api endpoint not responding. Try again later...';
@@ -605,7 +605,7 @@ exports.ERR_SANDBOX_ENDPOINTS_NOT_FOUND = 'No endpoints found';
 // Sandbox cp command
 exports.DESC_COMMAND_SANDBOX_CP = 'Copy files/directories to sandbox';
 exports.OPTION_SANDBOX_CP_SOURCE = 'Upload: local file (directory) path to upload. Download: sandbox remote file (directory): sandbox-id:/path to download';
-exports.OPTION_SANDBOX_CP_DEST = 'Upload: Sandbox remote file (directory): sandbox-id:/path to upload to. Download: local directory path to download to';
+exports.OPTION_SANDBOX_CP_DEST = 'Upload: Sandbox remote directory: sandbox-id:/path to upload to. Download: local directory path to download to';
 exports.OPTION_SANDBOX_CP_DOWNLOAD_MERGE = 'Merge contents of the destination directory with sandbox content';
 exports.OPTION_SANDBOX_CP_DOWNLOAD_REPLACE = 'Replace contents of the destination directory with sandbox content';
 exports.TXT_SANDBOX_CP_DOWNLOAD = 'Downloading...';
@@ -766,3 +766,182 @@ exports.TXT_PROJECT_SET_CLEARED = 'Project cleared';
 exports.TXT_LOGIN_SELECT_PROJECT = 'Select project (optional):';
 exports.ERR_PROJECT_NO_PROJECTS = 'No projects found in this workspace';
 exports.TXT_PROJECT_NONE = 'No project configured. Run "bdy login" or "bdy project set" first.';
+// Examples
+exports.EXAMPLE_SANDBOX_CP = `
+EXAMPLES:
+  # copy file from sandbox to new local directory:
+  bdy sb cp sandbox-identifier:/path/to/file /path/to/dir
+  
+  # copy contents of directory from sandbox to existing local directory merging it contents:
+  bdy sb cp sandbox-identifier:/path/to/dir /path/to/dir --merge
+  
+  # copy contents of directory from sandbox to existing local directory replacing it contents:
+  bdy sb co sandbox-identifier:/path/to/dir /path/to/dir --replace
+  
+  # copy local file to sandbox directory:
+  bdy sb cp /path/to/file sandbox-identifier:/path/to/dir
+  
+  # copy contents of local directory to sandbox directory:
+  bdy sb cp /path/to/dir sandbox-identifier:/path/to/dir`;
+exports.EXAMPLE_SANDBOX_CREATE = `
+EXAMPLES:
+  # create ubuntu 22.04 sandbox with name and wait for start:
+  bdy sb create -n "name" --os ubuntu:22.04  --wait-for-running
+  
+  # create sandbox with identifier, run install commands and wait for start & commands to complete:
+  bdy sb create -i "test" --install-command "apt-get update && apt-get install curl -y" --wait-for-configure
+  
+  # create sandbox with custom resources and tag it:
+  bdy sb create --resources 4x8 --tag "tag1" --tag "tag2"`;
+exports.EXAMPLE_SANDBOX_EXEC_COMMAND = `
+  # ran command in sandbox:
+  bdy sb exec command sandbox-identifier "ls -la"
+  
+  # ran command in sandbox and wait for it to complete:
+  bdy sb exec command sandbox-identifier "sleep 10" --wait`;
+exports.EXAMPLE_SANDBOX_EXEC_KILL = `
+  # kill command running in sandbox:
+  bdy sb exec kill sandbox-identifier command-id
+  
+  # kill command running in sandbox and automatically confirm killing:
+  bdy sb exec kill sandbox-identifier command-id -f`;
+exports.EXAMPLE_SANDBOX_EXEC_LIST = `
+  # list commands running in sandbox:
+  bdy sb exec ls sandbox-identifier
+  
+  # list commands running in sandbox in different project:
+  bdy sb exec ls sandbox-identifier -p project`;
+exports.EXAMPLE_SANDBOX_EXEC_LOGS = `
+  # show logs from command:
+  bdy sb exec logs sandbox-identifier command-id
+  
+  # show logs from command and wait for it to complete:
+  bdy sb exec logs sandbox-identifier command-id --wait`;
+exports.EXAMPLE_SANDBOX_EXEC_STATUS = `
+  # show status of command:
+  bdy sb exec status sandbox-identifier command-id
+  
+  # show status of command in sandbox from another workspace:
+  bdy sb exec status sandbox-identifier command-id -w workspace -p project`;
+exports.EXAMPLE_SANDBOX_SNAPSHOT_CREATE = `
+  # create snapshot of sandbox with name:
+  bdy sb snap create sandbox-identifier -n "my-snapshot"
+  
+  # create snapshot of sandbox and wait for it to complete:
+  bdy sb snap create sandbox-identifier --wait`;
+exports.EXAMPLE_SANDBOX_SNAPSHOT_DELETE = `
+  # delete snapshot of sandbox:
+  bdy sb snap rm sandbox-identifier my-snapshot
+  
+  # delete snapshot of sandbox and automatically confirm deletion:
+  bdy sb snap rm sandbox-identifier my-snapshot -f`;
+exports.EXAMPLE_SANDBOX_SNAPSHOT_GET = `
+  # get snapshot info:
+  bdy sb snap get sandbox-identifier my-snapshot
+  
+  # get snapshot info from sandbox in another project:
+  bdy sb snap get sandbox-identifier my-snapshot -p project`;
+exports.EXAMPLE_SANDBOX_SNAPSHOT_LIST = `
+  # list snapshots of sandbox:
+  bdy sb snap ls sandbox-identifier
+  
+  # list snapshots in default project:
+  bdy sb snap ls`;
+exports.EXAMPLE_SANDBOX_ENDPOINT_CREATE = `
+  # create http endpoint on port 80
+  bdy sb ep create sandbox-identifier -e 80
+  
+  # create http server and serve files from sandbox directory:
+  bdy sb ep create sandbox-identifier -s /path/to/dir
+  
+  # create tcp endpoint on port 22 with name:
+  bdy sb ep create sandbox-identifier -t TCP -e 22 -n test`;
+exports.EXAMPLE_SANDBOX_ENDPOINT_DELETE = `
+  # delete sandbox endpoint:
+  bdy sb ep rm sandbox-identifier test
+  
+  # delete sandbox endpoint in another project and automatically confirm deletion:
+  bdy sb ep rm sandbox-identifier test -p project -f`;
+exports.EXAMPLE_SANDBOX_ENDPOINT_GET = `
+  # get sandbox endpoint:
+  bdy sb ep get sandbox-identifier test
+  
+  # get sandbox endpoint in another project:
+  bdy sb ep get sandbox-identifier test -p project`;
+exports.EXAMPLE_SANDBOX_ENDPOINT_LIST = `
+  # list sandbox endpoints:
+  bdy sb ep ls sandbox-identifier
+  
+  # list sandbox endpoints in another project:
+  bdy sb ep ls sandbox-identifier -p project`;
+exports.EXAMPLE_PIPELINE_RUN = `
+EXAMPLES:
+  # run pipeline with high priority and upload everything from scratch
+  bdy pip run pipeline-identifier --priority HIGH -f
+  
+  # run pipeline without cache and wait for execution to complete
+  bdy pip run pipeline-identifier --wait -c
+  
+  # run pipeline and pass custom variables to execution
+  bdy pip run pipeline-identifier -v key:val -v a:b`;
+exports.EXAMPLE_PACKAGE_PUBLISH = `
+EXAMPLES:
+  # publish new version of file package:
+  bdy pkg pub package-identifier@version /path/to/dir
+  
+  # create new file package:
+  bdy pkg pub package-identifier --create
+  
+  # overwrite existing version:
+  bdy pkg pub package-identifier@version /path/to/dir -f`;
+exports.EXAMPLE_PACKAGE_DOWNLOAD = `
+EXAMPLES:
+  # download file package version to local directory:
+  bdy pkg dd package-identifier@version /path/to/dir
+  
+  # download latest file package version and replace contents of existing local directory:
+  bdy pkg dd package-identifier /path/to/dir --replace
+  
+  # download file package version and merge it with existing local directory:
+  bdy pkg dd package-identifier@version /path/to/dir --merge`;
+exports.EXAMPLE_PACKAGE_DELETE = `
+EXAMPLES:
+  # delete package:
+  bdy pkg rm package-identifier
+  
+  # delete package and automatically confirm deletion:
+  bdy pkg rm package-identifier -f`;
+exports.EXAMPLE_PACKAGE_CREATE = `
+EXAMPLES:
+  # create file package with name:
+  bdy pkg create test
+  
+  # create file package with buddy authorization and identifier
+  bdy pkg create test -b -i package-identifier
+  
+  # create file package with basic authorization
+  bdy pkg create -a user:pass
+  
+  # create docker containers package
+  bdy pkg create registry -t CONTAINER`;
+exports.EXAMPLE_PACKAGE_VERSION_LIST = `
+EXAMPLES:
+  # list package versions:
+  bdy pkg ver ls package-identifier
+  
+  # list 20 package versions from page 2:
+  bdy pkg ver ls package-identifier --page 2 --per-page 20`;
+exports.EXAMPLE_PACKAGE_VERSION_GET = `
+EXAMPLES:
+  # get package version:
+  bdy pkg ver get package-identifier version
+  
+  # get package version in another project:
+  bdy pkg ver get package-identifier version -p project`;
+exports.EXAMPLE_PACKAGE_VERSION_DELETE = `
+EXAMPLES:
+  # delete package version:
+  bdy pkg ver rm package-identifier version
+  
+  # delete package version and automatically confirm deletion:
+  bdy pkg ver rm package-identifier version -f`;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.16.29-dev",
+  "version": "1.16.30-dev",
   "type": "commonjs",
   "license": "MIT",
   "scripts": {