/*WRITE ONLY BELOW THIS LINE*/ /*WRITE ONLY ABOVE THIS LINE*/ "use strict"; const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = { a: "a", code: "code", h1: "h1", h3: "h3", p: "p", pre: "pre", ..._provideComponents(), ...props.components }, {CliCommandsApiReference} = _components; if (!CliCommandsApiReference) _missingMdxReference("CliCommandsApiReference", true); return _jsxs(_Fragment, { children: [_jsx(_components.h1, { id: "overview-and-basic-usage", children: "Overview and basic usage" }), "\n", _jsx(_components.h3, { id: "login", children: "login" }), "\n", _jsx(_components.p, { children: "Configures your Stacktape API key for the current system." }), "\n", _jsxs(_components.p, { children: ["All subsequent operations will be associated with the user and organization linked to this API key. You can get your API\nkey from the ", _jsx(_components.a, { href: "https://console.stacktape.com/api-keys", children: "Stacktape console" }), ". You can provide the key with the ", _jsx(_components.code, { children: "--apiKey" }), "\noption or enter it interactively."] }), "\n", _jsx("br", {}), "\n", "\n", "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "language-bash", children: "stacktape login\n" }) }), "\n", _jsx(_components.h1, { id: "api-reference", children: "API reference" }), "\n", _jsx(CliCommandsApiReference, { command: "login", sortedArgs: [{ description: "#### API Key\n\n---\n\nYour Stacktape API key. You can get your key from the [Stacktape console](https://console.stacktape.com/api-keys). If you don't provide a key, you will be prompted to enter it. Note that providing the key directly in the command line is insecure, as it will be saved in your terminal history.", allowedTypes: ["string"], alias: "ak", required: false, name: "apiKey", shortDescription: "

API Key

\n", longDescription: '

Your Stacktape API key. You can get your key from the Stacktape console. If you don't provide a key, you will be prompted to enter it. Note that providing the key directly in the command line is insecure, as it will be saved in your terminal history.

\n' }, { description: "#### AWS Account\n\n---\n\nThe name of the AWS account to use for the operation. The account must first be connected in the [Stacktape console](https://console.stacktape.com/aws-accounts).", allowedTypes: ["string"], alias: "aa", required: false, name: "awsAccount", shortDescription: "

AWS Account

\n", longDescription: '

The name of the AWS account to use for the operation. The account must first be connected in the Stacktape console.

\n' }, { description: "#### Show Help\n\n---\n\nIf provided, the command will not execute and will instead print help information.", allowedTypes: ["string"], alias: "h", required: false, name: "help", shortDescription: "

Show Help

\n", longDescription: "

If provided, the command will not execute and will instead print help information.

\n" }, { description: "#### Log Format\n\n---\n\nThe format of logs printed to the console.\n\n- `fancy`: Colorized and dynamically re-rendered logs.\n- `normal`: Colorized but not dynamically re-rendered logs.\n- `basic`: Simple text only.\n- `json`: Logs printed as JSON objects.", allowedTypes: ["string"], allowedValues: ["basic", "fancy", "json", "normal"], alias: "lf", required: false, name: "logFormat", shortDescription: "

Log Format

\n", longDescription: "

The format of logs printed to the console.

fancy: Colorized and dynamically re-rendered logs.
normal: Colorized but not dynamically re-rendered logs.
basic: Simple text only.
json: Logs printed as JSON objects.

\n" }, { description: "#### Log Level\n\n---\n\nThe level of logs to print to the console.\n\n- `info`: Basic information about the operation.\n- `error`: Only errors.\n- `debug`: Detailed information for debugging.", allowedTypes: ["string"], allowedValues: ["debug", "error", "info"], alias: "ll", required: false, name: "logLevel", shortDescription: "

Log Level

\n", longDescription: "

The level of logs to print to the console.

info: Basic information about the operation.
error: Only errors.
debug: Detailed information for debugging.

\n" }, { description: "#### AWS Profile\n\n---\n\nThe AWS profile to use for the command. You can manage profiles using the `aws-profile:*` commands and set a default profile with `defaults:configure`.", allowedTypes: ["string"], alias: "p", required: false, name: "profile", shortDescription: "

AWS Profile

\n", longDescription: "

The AWS profile to use for the command. You can manage profiles using the aws-profile:* commands and set a default profile with defaults:configure.

\n" }] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }