@knocklabs/cli 0.1.4 → 0.1.6

package/README.md

@@ -16,7 +16,7 @@ $ npm install -g @knocklabs/cli
 $ knock COMMAND
 running command...
 $ knock (--version)
-@knocklabs/cli/0.1.4 linux-x64 node-v18.16.1
+@knocklabs/cli/0.1.6 linux-x64 node-v18.18.0
 $ knock --help [COMMAND]
 USAGE
   $ knock COMMAND
@@ -30,6 +30,11 @@ USAGE
 * [`knock commit`](#knock-commit)
 * [`knock commit promote`](#knock-commit-promote)
 * [`knock help [COMMANDS]`](#knock-help-commands)
+* [`knock layout get EMAILLAYOUTKEY`](#knock-layout-get-emaillayoutkey)
+* [`knock layout list`](#knock-layout-list)
+* [`knock layout pull [EMAILLAYOUTKEY]`](#knock-layout-pull-emaillayoutkey)
+* [`knock layout push [EMAILLAYOUTKEY]`](#knock-layout-push-emaillayoutkey)
+* [`knock layout validate [EMAILLAYOUTKEY]`](#knock-layout-validate-emaillayoutkey)
 * [`knock plugins`](#knock-plugins)
 * [`knock plugins:install PLUGIN...`](#knock-pluginsinstall-plugin)
 * [`knock plugins:inspect PLUGIN...`](#knock-pluginsinspect-plugin)
@@ -70,7 +75,7 @@ FLAGS
   --service-token=<value>       (required) The service token to authenticate with.
 ```
 
-_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.4/dist/commands/commit/index.ts)_
+_See code: [dist/commands/commit/index.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/commit/index.ts)_
 
 ## `knock commit promote`
 
@@ -86,6 +91,8 @@ FLAGS
   --to=<value>             (required) The destination environment to promote changes from the preceding environment.
 ```
 
+_See code: [dist/commands/commit/promote.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/commit/promote.ts)_
+
 ## `knock help [COMMANDS]`
 
 Display help for knock.
@@ -104,7 +111,111 @@ DESCRIPTION
   Display help for knock.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.11/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+
+## `knock layout get EMAILLAYOUTKEY`
+
+Display a single email layout from an environment.
+
+```
+USAGE
+  $ knock layout get EMAILLAYOUTKEY --service-token <value> [--environment <value>] [--hide-uncommitted-changes]
+    [--json]
+
+FLAGS
+  --environment=<value>       [default: development] The environment to use.
+  --hide-uncommitted-changes  Hide any uncommitted changes.
+  --service-token=<value>     (required) The service token to authenticate with.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+_See code: [dist/commands/layout/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/layout/get.ts)_
+
+## `knock layout list`
+
+Display all email layouts for an environment.
+
+```
+USAGE
+  $ knock layout list --service-token <value> [--environment <value>] [--hide-uncommitted-changes] [--after
+    <value>] [--before <value>] [--limit <value>] [--json]
+
+FLAGS
+  --after=<value>             The cursor after which to fetch the next page.
+  --before=<value>            The cursor before which to fetch the previous page.
+  --environment=<value>       [default: development] The environment to use.
+  --hide-uncommitted-changes  Hide any uncommitted changes.
+  --limit=<value>             The total number of entries to fetch per page.
+  --service-token=<value>     (required) The service token to authenticate with.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+```
+
+_See code: [dist/commands/layout/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/layout/list.ts)_
+
+## `knock layout pull [EMAILLAYOUTKEY]`
+
+Pull one or more email layouts from an environment into a local file system.
+
+```
+USAGE
+  $ knock layout pull [EMAILLAYOUTKEY] --service-token <value> [--environment <value>] [--layouts-dir <value>
+    --all] [--hide-uncommitted-changes] [--force]
+
+FLAGS
+  --all                       Whether to pull all email layouts from the specified environment.
+  --environment=<value>       [default: development] The environment to use.
+  --force                     Remove the confirmation prompt.
+  --hide-uncommitted-changes  Hide any uncommitted changes.
+  --layouts-dir=<value>       The target directory path to pull all email layouts into.
+  --service-token=<value>     (required) The service token to authenticate with.
+```
+
+_See code: [dist/commands/layout/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/layout/pull.ts)_
+
+## `knock layout push [EMAILLAYOUTKEY]`
+
+Push one or more email layouts from a local file system to Knock.
+
+```
+USAGE
+  $ knock layout push [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
+    --all] [-m <value> --commit]
+
+FLAGS
+  -m, --commit-message=<value>  Use the given value as the commit message
+  --all                         Whether to push all layouts from the target directory.
+  --commit                      Push and commit the layout(s) at the same time
+  --environment=<option>        [default: development] Pushing an email layout is only allowed in the development
+                                environment
+                                <options: development>
+  --layouts-dir=<value>         The target directory path to find all layouts to push.
+  --service-token=<value>       (required) The service token to authenticate with.
+```
+
+_See code: [dist/commands/layout/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/layout/push.ts)_
+
+## `knock layout validate [EMAILLAYOUTKEY]`
+
+Validate one or more layouts from a local file system.
+
+```
+USAGE
+  $ knock layout validate [EMAILLAYOUTKEY] --service-token <value> [--environment development] [--layouts-dir <value>
+    --all]
+
+FLAGS
+  --all                    Whether to validate all layouts from the target directory.
+  --environment=<option>   [default: development] Validating a layout is only done in the development environment
+                           <options: development>
+  --layouts-dir=<value>    The target directory path to find all layouts to validate.
+  --service-token=<value>  (required) The service token to authenticate with.
+```
+
+_See code: [dist/commands/layout/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/layout/validate.ts)_
 
 ## `knock plugins`
 
@@ -127,7 +238,7 @@ EXAMPLES
   $ knock plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.6/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/index.ts)_
 
 ## `knock plugins:install PLUGIN...`
 
@@ -192,6 +303,8 @@ EXAMPLES
   $ knock plugins:inspect myplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/inspect.ts)_
+
 ## `knock plugins:install PLUGIN...`
 
 Installs a plugin into the CLI.
@@ -230,6 +343,8 @@ EXAMPLES
   $ knock plugins:install someuser/someplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/install.ts)_
+
 ## `knock plugins:link PLUGIN`
 
 Links a plugin into the CLI for development.
@@ -242,8 +357,9 @@ ARGUMENTS
   PATH  [default: .] path to plugin
 
 FLAGS
-  -h, --help     Show CLI help.
+  -h, --help      Show CLI help.
   -v, --verbose
+  --[no-]install  Install dependencies after linking the plugin.
 
 DESCRIPTION
   Links a plugin into the CLI for development.
@@ -257,6 +373,8 @@ EXAMPLES
   $ knock plugins:link myplugin
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/link.ts)_
+
 ## `knock plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
@@ -303,6 +421,8 @@ ALIASES
   $ knock plugins remove
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/uninstall.ts)_
+
 ## `knock plugins:uninstall PLUGIN...`
 
 Removes a plugin from the CLI.
@@ -342,6 +462,8 @@ DESCRIPTION
   Update installed plugins.
 ```
 
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/update.ts)_
+
 ## `knock translation get TRANSLATIONREF`
 
 Display a single translation from an environment.
@@ -365,6 +487,8 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
+_See code: [dist/commands/translation/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/translation/get.ts)_
+
 ## `knock translation list`
 
 Display all translations for an environment.
@@ -386,6 +510,8 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
+_See code: [dist/commands/translation/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/translation/list.ts)_
+
 ## `knock translation pull [TRANSLATIONREF]`
 
 Pull one or more translations from an environment into a local file system.
@@ -409,6 +535,8 @@ FLAGS
   --translations-dir=<value>  The target directory path to pull all translations into.
 ```
 
+_See code: [dist/commands/translation/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/translation/pull.ts)_
+
 ## `knock translation push [TRANSLATIONREF]`
 
 Push one or more translations from a local file system to Knock.
@@ -434,6 +562,8 @@ FLAGS
   --translations-dir=<value>    The target directory path to find all translations to push.
 ```
 
+_See code: [dist/commands/translation/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/translation/push.ts)_
+
 ## `knock translation validate [TRANSLATIONREF]`
 
 Validate one or more translations from a local file system.
@@ -457,6 +587,8 @@ FLAGS
   --translations-dir=<value>  The target directory path to find all translations to validate.
 ```
 
+_See code: [dist/commands/translation/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/translation/validate.ts)_
+
 ## `knock whoami`
 
 Verify the provided service token.
@@ -472,7 +604,7 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
-_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.4/dist/commands/whoami.ts)_
+_See code: [dist/commands/whoami.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/whoami.ts)_
 
 ## `knock workflow activate WORKFLOWKEY`
 
@@ -499,6 +631,8 @@ DESCRIPTION
   with `false` in order to deactivate it.
 ```
 
+_See code: [dist/commands/workflow/activate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/activate.ts)_
+
 ## `knock workflow get WORKFLOWKEY`
 
 Display a single workflow from an environment.
@@ -517,6 +651,8 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
+_See code: [dist/commands/workflow/get.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/get.ts)_
+
 ## `knock workflow list`
 
 Display all workflows for an environment.
@@ -538,6 +674,8 @@ GLOBAL FLAGS
   --json  Format output as json.
 ```
 
+_See code: [dist/commands/workflow/list.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/list.ts)_
+
 ## `knock workflow pull [WORKFLOWKEY]`
 
 Pull one or more workflows from an environment into a local file system.
@@ -556,6 +694,8 @@ FLAGS
   --workflows-dir=<value>     The target directory path to pull all workflows into.
 ```
 
+_See code: [dist/commands/workflow/pull.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/pull.ts)_
+
 ## `knock workflow push [WORKFLOWKEY]`
 
 Push one or more workflows from a local file system to Knock.
@@ -575,6 +715,8 @@ FLAGS
   --workflows-dir=<value>       The target directory path to find all workflows to push.
 ```
 
+_See code: [dist/commands/workflow/push.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/push.ts)_
+
 ## `knock workflow run WORKFLOWKEY`
 
 Test run a workflow using the latest version from Knock.
@@ -594,6 +736,8 @@ FLAGS
   --tenant=<value>         A tenant id for the workflow run.
 ```
 
+_See code: [dist/commands/workflow/run.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/run.ts)_
+
 ## `knock workflow validate [WORKFLOWKEY]`
 
 Validate one or more workflows from a local file system.
@@ -610,4 +754,6 @@ FLAGS
   --service-token=<value>  (required) The service token to authenticate with.
   --workflows-dir=<value>  The target directory path to find all workflows to validate.
 ```
+
+_See code: [dist/commands/workflow/validate.ts](https://github.com/knocklabs/knock-cli/blob/v0.1.6/dist/commands/workflow/validate.ts)_
 <!-- commandsstop -->

package/dist/commands/layout/get.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>EmailLayoutGet
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _date = require("../../lib/helpers/date");
+const _request = require("../../lib/helpers/request");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class EmailLayoutGet extends _baseCommand.default {
+    async run() {
+        const { flags  } = this.props;
+        const resp = await (0, _request.withSpinner)(()=>this.apiV1.getEmailLayout(this.props));
+        if (flags.json) return resp.data;
+        this.render(resp.data);
+    }
+    render(email_layout) {
+        const { emailLayoutKey  } = this.props.args;
+        const { environment: env , "hide-uncommitted-changes": commitedOnly  } = this.props.flags;
+        const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
+        this.log(`‣ Showing email layout \`${emailLayoutKey}\` in \`${env}\` environment ${qualifier}\n`);
+        /*
+     * Email layout table
+     */ const rows = [
+            {
+                key: "Key",
+                value: email_layout.key
+            },
+            {
+                key: "Name",
+                value: email_layout.name
+            },
+            {
+                key: "Updated at",
+                value: (0, _date.formatDate)(email_layout.updated_at)
+            },
+            {
+                key: "Created at",
+                value: (0, _date.formatDate)(email_layout.created_at)
+            }
+        ];
+        _core.ux.table(rows, {
+            key: {
+                header: "Email layout",
+                minWidth: 24
+            },
+            value: {
+                header: "",
+                minWidth: 16
+            }
+        });
+        this.log("");
+        if (email_layout.footer_links) {
+            const footerLinks = (email_layout.footer_links || []).map((link)=>({
+                    key: link.text,
+                    value: link.url
+                }));
+            _core.ux.table(footerLinks, {
+                key: {
+                    header: "Footer Links",
+                    minWidth: 24
+                },
+                value: {
+                    header: "",
+                    minWidth: 16
+                }
+            });
+        }
+    }
+}
+EmailLayoutGet.summary = "Display a single email layout from an environment.";
+EmailLayoutGet.flags = {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    })
+};
+EmailLayoutGet.args = {
+    emailLayoutKey: _core.Args.string({
+        required: true
+    })
+};
+EmailLayoutGet.enableJsonFlag = true;

package/dist/commands/layout/list.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>EmailLayoutList
+});
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _date = require("../../lib/helpers/date");
+const _object = require("../../lib/helpers/object");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+class EmailLayoutList extends _baseCommand.default {
+    async run() {
+        const resp = await this.request();
+        const { flags  } = this.props;
+        if (flags.json) return resp.data;
+        this.render(resp.data);
+    }
+    async request(pageParams = {}) {
+        const props = (0, _object.merge)(this.props, {
+            flags: {
+                ...pageParams
+            }
+        });
+        return (0, _request.withSpinner)(()=>this.apiV1.listEmailLayouts(props));
+    }
+    async render(data) {
+        const { entries  } = data;
+        const { environment: env , "hide-uncommitted-changes": commitedOnly  } = this.props.flags;
+        const qualifier = env === "development" && !commitedOnly ? "(including uncommitted)" : "";
+        this.log(`‣ Showing ${entries.length} email layouts in \`${env}\` environment ${qualifier}\n`);
+        /*
+     * Email layouts table
+     */ _core.ux.table(entries, {
+            key: {
+                header: "Key"
+            },
+            name: {
+                header: "Name"
+            },
+            updated_at: {
+                header: "Updated at",
+                get: (entry)=>(0, _date.formatDate)(entry.updated_at)
+            },
+            created_at: {
+                header: "Created at",
+                get: (entry)=>(0, _date.formatDate)(entry.created_at)
+            }
+        });
+        return this.prompt(data);
+    }
+    async prompt(data) {
+        const { page_info  } = data;
+        const pageAction = await (0, _page.maybePromptPageAction)(page_info);
+        const pageParams = pageAction && (0, _page.paramsForPageAction)(pageAction, page_info);
+        if (pageParams) {
+            this.log("\n");
+            const resp = await this.request(pageParams);
+            return this.render(resp.data);
+        }
+    }
+}
+EmailLayoutList.summary = "Display all email layouts for an environment.";
+EmailLayoutList.flags = {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    }),
+    ..._page.pageFlags
+};
+EmailLayoutList.enableJsonFlag = true;

package/dist/commands/layout/pull.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: ()=>EmailLayoutPull
+});
+const _nodePath = /*#__PURE__*/ _interopRequireWildcard(require("node:path"));
+const _core = require("@oclif/core");
+const _baseCommand = /*#__PURE__*/ _interopRequireDefault(require("../../lib/base-command"));
+const _error = require("../../lib/helpers/error");
+const _flag = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/helpers/flag"));
+const _object = require("../../lib/helpers/object");
+const _page = require("../../lib/helpers/page");
+const _request = require("../../lib/helpers/request");
+const _ux = require("../../lib/helpers/ux");
+const _emailLayout = /*#__PURE__*/ _interopRequireWildcard(require("../../lib/marshal/email-layout"));
+const _runContext = require("../../lib/run-context");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+class EmailLayoutPull extends _baseCommand.default {
+    async run() {
+        const { args , flags  } = this.props;
+        if (flags.all && args.emailLayoutKey) {
+            return this.error(`emailLayoutKey arg \`${args.emailLayoutKey}\` cannot also be provided when using --all`);
+        }
+        return flags.all ? this.pullAllEmailLayouts() : this.pullOneEmailLayout();
+    }
+    // Pull one email layout
+    async pullOneEmailLayout() {
+        const { flags  } = this.props;
+        const dirContext = await this.getEmailLayoutDirContext();
+        if (dirContext.exists) {
+            this.log(`‣ Found \`${dirContext.key}\` at ${dirContext.abspath}`);
+        } else {
+            const prompt = `Create a new email layout directory \`${dirContext.key}\` at ${dirContext.abspath}?`;
+            const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+            if (!input) return;
+        }
+        const resp = await (0, _request.withSpinner)(()=>{
+            const props = (0, _object.merge)(this.props, {
+                args: {
+                    emailLayoutKey: dirContext.key
+                },
+                flags: {
+                    annotate: true
+                }
+            });
+            return this.apiV1.getEmailLayout(props);
+        });
+        await _emailLayout.writeEmailLayoutDirFromData(dirContext, resp.data);
+        const action = dirContext.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${action} \`${dirContext.key}\` at ${dirContext.abspath}`);
+    }
+    // Pull all email layouts
+    async pullAllEmailLayouts() {
+        const { flags  } = this.props;
+        const defaultToCwd = {
+            abspath: this.runContext.cwd,
+            exists: true
+        };
+        const targetDirCtx = flags["layouts-dir"] || defaultToCwd;
+        const prompt = targetDirCtx.exists ? `Pull latest layouts into ${targetDirCtx.abspath}?\n  This will overwrite the contents of this directory.` : `Create a new layouts directory at ${targetDirCtx.abspath}?`;
+        const input = flags.force || await (0, _ux.promptToConfirm)(prompt);
+        if (!input) return;
+        _ux.spinner.start(`‣ Loading`);
+        const emailLayouts = await this.listAllEmailLayouts();
+        await _emailLayout.writeEmailLayoutIndexDir(targetDirCtx, emailLayouts);
+        _ux.spinner.stop();
+        const action = targetDirCtx.exists ? "updated" : "created";
+        this.log(`‣ Successfully ${action} the layouts directory at ${targetDirCtx.abspath}`);
+    }
+    async listAllEmailLayouts(pageParams = {}, emailLayoutsFetchedSoFar = []) {
+        const props = (0, _object.merge)(this.props, {
+            flags: {
+                ...pageParams,
+                annotate: true,
+                limit: _page.MAX_PAGINATION_LIMIT
+            }
+        });
+        const resp = await this.apiV1.listEmailLayouts(props);
+        if (!(0, _request.isSuccessResp)(resp)) {
+            const message = (0, _request.formatErrorRespMessage)(resp);
+            this.error(new _error.ApiError(message));
+        }
+        const { entries , page_info: pageInfo  } = resp.data;
+        const emailLayouts = [
+            ...emailLayoutsFetchedSoFar,
+            ...entries
+        ];
+        return pageInfo.after ? this.listAllEmailLayouts({
+            after: pageInfo.after
+        }, emailLayouts) : emailLayouts;
+    }
+    async getEmailLayoutDirContext() {
+        const { emailLayoutKey  } = this.props.args;
+        const { resourceDir , cwd: runCwd  } = this.runContext;
+        // Inside an existing resource dir, use it if valid for the target email layout.
+        if (resourceDir) {
+            const target = {
+                commandId: _baseCommand.default.id,
+                type: "email_layout",
+                key: emailLayoutKey
+            };
+            return (0, _runContext.ensureResourceDirForTarget)(resourceDir, target);
+        }
+        // Not inside any existing email layout directory, which means either create a
+        // new email layout directory in the cwd, or update it if there is one already.
+        if (emailLayoutKey) {
+            const dirPath = _nodePath.resolve(runCwd, emailLayoutKey);
+            const exists = await _emailLayout.isEmailLayoutDir(dirPath);
+            return {
+                type: "email_layout",
+                key: emailLayoutKey,
+                abspath: dirPath,
+                exists
+            };
+        }
+        // Not in any email layout directory, nor a email layout key arg was given so error.
+        return this.error("Missing 1 required arg:\nemailLayoutKey");
+    }
+}
+EmailLayoutPull.summary = "Pull one or more email layouts from an environment into a local file system.";
+EmailLayoutPull.flags = {
+    environment: _core.Flags.string({
+        default: "development",
+        summary: "The environment to use."
+    }),
+    all: _core.Flags.boolean({
+        summary: "Whether to pull all email layouts from the specified environment."
+    }),
+    "layouts-dir": _flag.dirPath({
+        summary: "The target directory path to pull all email layouts into.",
+        dependsOn: [
+            "all"
+        ],
+        aliases: [
+            "email-layouts-dir"
+        ]
+    }),
+    "hide-uncommitted-changes": _core.Flags.boolean({
+        summary: "Hide any uncommitted changes."
+    }),
+    force: _core.Flags.boolean({
+        summary: "Remove the confirmation prompt."
+    })
+};
+EmailLayoutPull.args = {
+    emailLayoutKey: _core.Args.string({
+        required: false
+    })
+};