UNPKG

balena-cli

Version:

The official balena Command Line Interface

16 lines (15 loc) 4.26 kB
export declare const reachingOut = "For further help or support, visit:\nhttps://www.balena.io/docs/reference/balena-cli/#support-faq-and-troubleshooting\n"; export declare const help = "For further help or support, visit:\nhttps://www.balena.io/docs/reference/balena-cli/#support-faq-and-troubleshooting\n"; export declare const getHelp: () => string; export declare const deprecationPolicyNote = "The balena CLI enforces its deprecation policy by exiting with an error a year\nafter the release of the next major version, unless the --unsupported option is\nused. Find out more at: https://git.io/JRHUW#deprecation-policy\n"; export declare function warnify(msg: string, prefix?: string): string; export declare const balenaAsciiArt = " _ _\n| |__ __ _ | | ____ _ __ __ _\n| '_ \\ / _` || | / __ \\| '_ \\ / _` |\n| |_) | (_) || || ___/| | | || (_) |\n|_.__/ \\__,_||_| \\____/|_| |_| \\__,_|\n"; export declare const registrySecretsHelp: string; export declare const dockerignoreHelp: string; export declare const applicationIdInfo = "Fleets may be specified by fleet name or slug. Fleet slugs are\nthe recommended option, as they are unique and unambiguous. Slugs can be\nlisted with the `balena fleet list` command. Note that slugs may change if the\nfleet is renamed. Fleet names are not unique and may result in \"Fleet is\nambiguous\" errors at any time (even if it \"used to work in the past\"), for\nexample if the name clashes with a newly created public fleet, or with fleets\nfrom other balena accounts that you may be invited to join under any role.\nFor this reason, fleet names are especially discouraged in scripts (e.g. CI\nenvironments)."; export declare const applicationNameNote = "Fleets may be specified by fleet name or slug. Slugs are recommended because\nthey are unique and unambiguous. Slugs can be listed with the `balena fleet list`\ncommand. Note that slugs may change if the fleet is renamed. Fleet names are\nnot unique and may result in \"Fleet is ambiguous\" errors at any time (even if\n\"it used to work in the past\"), for example if the name clashes with a newly\ncreated public/open fleet, or with fleets from other balena accounts that you\nmay be invited to join under any role. For this reason, fleet names are\nespecially discouraged in scripts (e.g. CI environments)."; export declare const devModeInfo = "The '--dev' option is used to configure balenaOS to operate in development mode,\nallowing anauthenticated root ssh access and exposing network ports such as\nbalenaEngine's 2375 (unencrypted). This option causes `\"developmentMode\": true`\nto be inserted in the 'config.json' file in the image's boot partion. Development\nmode (as a configurable option) is applicable to balenaOS releases from early\n2022. Older releases have separate development and production balenaOS images\nthat cannot be reconfigured through 'config.json' or the '--dev' option. Do not\nconfuse the balenaOS \"development mode\" with a device's \"local mode\", the latter\nbeing a supervisor feature that allows the \"balena push\" command to push a user's\napplication directly to a device in the local network."; export declare const secureBootInfo = "The '--secureBoot' option is used to configure a balenaOS installer image to opt-in\nsecure boot and disk encryption."; export declare const jsonInfo = "The --json option is recommended when scripting the output of this command,\nbecause field names are less likely to change in JSON format and because it\nbetter represents data types like arrays, empty strings and null values.\nThe 'jq' utility may be helpful for querying JSON fields in shell scripts\n(https://stedolan.github.io/jq/manual/)."; export declare const buildArgDeprecation = "WARNING: You have specified a '--buildArg' option, which is now deprecated, and\nmay be removed in the future. The recommended alternative is build-time secrets:\nhttps://www.balena.io/docs/learn/deploy/deployment/#build-time-secrets-and-variables\n\nIf you have a particular use for buildArg, which is not satisfied by build-time\nsecrets, please contact us via support or the forums: https://forums.balena.io/\n\n"; export declare function getNodeEngineVersionWarn(version: string, validVersions: string): string;