package
0.0.0-20241018223127-a062be16fda2
Repository: https://github.com/activestate/cli.git
Documentation: pkg.go.dev
# Constants
ActivatedStateEnvVarName is the name of the environment variable that is set when in an activated state, its value will be the path of the project.
ActivatedStateIDEnvVarName is the name of the environment variable that is set when in an activated state, its value will be a unique id identifying a specific instance of an activated state.
ActivatedStateNamespaceEnvVarName is the name of the environment variable that specifies the activated state's org/project namespace.
ActivePerlExecutable represents the ActivePerl executable.
ActivePython2Executable represents the ActivePython executable.
ActivePython3Executable represents the ActivePython executable.
ActiveStateBlogURL is the URL for the ActiveState Blog.
ActiveStateCIEnvVarName is the environment variable set when running in an ActiveState CI environment.
ActiveStateDashboardURL is the URL for the ActiveState account preferences page.
ActiveStateSupportURL is the URL for the AciveState support page.
AnalyticsLogEnvVarName is used to instruct State Tool to report analytics events to the given file.
AnalyticsPixelOverrideEnv is the environment variable to check for overriding the analytics pixel url.
AnalyticsTrackingID is our Google Analytics tracking ID.
APIArtifactURL is the URL for downloading artifacts.
APIHostEnvVarName is the name of the environment variable that specifies the API host, specifying this overrides the activestate.yaml api url config.
APIInsecureEnvVarName is the name of the environment variable that specifies whether the API hostURI should be insecure.
APIKeyEnvVarName is the name of the environment variable that specifies the API Key to use for api authentication (overriding user config).
APIServiceOverrideEnvVarName is the name of the environment variable that specifies an optional override of the full API URL, the service name will be appended.
APITokenNamePrefix is the name we give our api token.
APIUpdateInfoURL is the URL for our update info server.
APIUpdateURL is the URL for our update files.
AppInstallDirOverrideEnvVarName is used to override the default app installation path of the state tool.
No description provided by the author
AsyncRuntimeConfig is the config key used to determine whether the user has opted in to async runtimes.
AutostartPathOverrideEnvVarName is used to override the default autostart path of the state service.
AutostartSvcConfigKey is the config key used to determine if the service should be run on startup.
AutoUpdateConfigKey is the config key for storing whether or not autoupdates can be performed.
AutoUpdateTimeoutEnvVarName is the name of the environment variable that can be set to override the allowed timeout to check for an available auto-update.
BetaChannel is the channel used for beta builds.
BugTrackerURL is the URL of our bug tracker.
BuildLogStreamerPath is the websocket API used for streaming build results.
BuildplanAPIPath is the path used for the build planner api.
BuildPlannerAPIPath is the path used for the build planner api.
BuildScriptFileName holds the name of the file that represents the build script used to generate the runtime.
CacheEnvVarName is the env var used to override the cache dir that the State Tool uses.
CheatSheetURL is the URL for the State Tool Cheat Sheet.
CommandName holds the name of our command.
ConfigEnvVarName is the env var used to override the config dir that the State Tool uses.
ConfigFileName holds the name of the file that the user uses to configure their project, not to be confused with InternalConfigFileNameLegacy.
CPUProfileEnvVarName is the name of the environment variable that specifies whether CPU profiling should be run.
DateFormatUser is the date format we use when communicating with the end-user.
DateTimeFormatRecord is the datetime format we use when recording for internal use.
DateTimeFormatUser is the datetime format we use when communicating with the end-user.
DebugServiceRequestsEnvVarName is used to instruct State Tool to turn on debug logging of service requests.
DefaultAnalyticsPixel is the default url for the analytics pixel.
DefaultAPIHost is the host used for platform api calls when on production.
DefaultBranchName is the default branch name used on platform projects.
DefaultNamespaceDomain is the domain used when no namespace is given and one has to be constructed.
DefaultRSABitLength represents the default RSA bit-length that will be assumed when generating new Keypairs.
DisableActivateEventsEnvVarName is the environment variable used to disable events when activating or checking out a project.
DisableAnalyticsEnvVarName is used to instruct State Tool to not send data to Google Analytics.
DisableBuildscriptDirtyCheck is the env var used to disable the check for dirty buildscripts.
DisableErrorTipsEnvVarName disables the display of tips in error messages.
DisableLanguageTemplates is the env var used to disable templating for new activestate.yaml files.
DisableRuntime is the env var used to disable downloading of runtimes, useful for CI or testing.
DisableUpdates is the env var used to disable automatic updates.
DocumentationURL is the url for the state tool documentation.
DocumentationURLGetStarted is the documentation URL for creating projects.
DocumentationURLLocking is the documentation URL for locking.
DocumentationURLMismatch is the documentation URL for the project mismatch warning.
E2ETestEnvVarName is the name of the environment variable that specifies that we are running under E2E tests.
EnvironmentEnvVarName is the name of the environment variable that specifies the current environment (dev, qa, prod, etc.).
ExecRecursionAllowEnvVarName is an environment variable overriding the recursion allowance.
ExecRecursionEnvVarName is an environment variable storing a string representation of the current recursion.
ExecRecursionLevelEnvVarName is an environment variable storing the number of times the executor has been called recursively.
ExecRecursionMaxLevelEnvVarName is an environment variable storing the number of times the executor may be called recursively.
ExpanderMaxDepth defines the maximum depth to fully expand a given value.
ExperimentalChannel is the channel used for experimental builds.
FirstMultiFileStateToolVersion is the State Tool version that introduced multi-file updates.
ForceUpdateEnvVarName is used to force state tool to update, regardless of whether the update is equal to the current version.
ForumsURL is the URL to the state tool forums.
ForwardedStateEnvVarName is the name of the environment variable that is set when in an activated state, its value will be the path of the project.
GlobalDefaultPrefname is the pref that holds the path to the globally defaulted project.
GraphqlAPIPath is the path used for the platform graphql api.
HasuraInventoryAPIPath is the path used for the hasura inventory api.
HeadChefAPIPath is the api path used for the headchef api.
HeartbeatIntervalEnvVarName is the name of the environment variable used to override the heartbeat interval.
HomeEnvVarName is the fallback env var used to determine the user's home directory.
No description provided by the author
No description provided by the author
IgnoreEnvEnvVarName is the environment variable to set for skipping specific environment variables during runtime setup.
InstallBuildDependenciesEnvVarName is the env var that is used to override whether to install build dependencies.
InstallerName is the name we give to our state-installer executable.
InstallerNoSubshell is an environment variable that if set to true will tell the installer not to start a subshell.
InstallPathOverrideEnvVarName is used to override the default installation path of the state tool.
InstallSourceFile is the file we use to record what installed the state tool.
InternalConfigFileName is the filename used for our sqlite based settings db.
InternalConfigFileNameLegacy is effectively the same as InternalConfigName, but includes our preferred extension.
InternalConfigNamespace holds the appdata folder name under which we store our config.
InventoryAPIPath is the api path used for the secrets api.
KeypairLocalFileName is the name of the file (sans extension) that will hold the user's unencrypted private key in their config dir.
LastUsedNamespacePrefname is the pref that holds the last used org for commands that use a project.
LegacyToplevelInstallArchiveDir is the top-level directory for files in an installation archive This constant will be removed in DX-2081.
LibraryLicense is the license that the library is distributed under.
LibraryName contains the main name of this library.
LibraryNamespace is the namespace that the library belongs to.
LibraryOwner contains the name of the owner of this library.
{OS}Bit{Depth}UUID constants are the UUIDs associated with the relevant OSes in the platform DB and leveraged by the Dashboard (PlatformMapping).
LogBuildVerboseEnvVarName is the env var used to enable verbose build logging.
LogEnvVarName is the env var used to override the log file path.
{OS}Bit{Depth}UUID constants are the UUIDs associated with the relevant OSes in the platform DB and leveraged by the Dashboard (PlatformMapping).
MediatorAPIPath is the path used for the platform mediator api.
MessagesInfoURL is the URL we check against to see what versions are deprecated.
MessagesOverrideEnvVarName is used to override the location of the messages file (for testing purposes - should hold local filepath).
MonoAPIPath is the api path used for the platform api.
NonInteractiveEnvVarName is the name of the environment variable that specifies whether to run the State Tool without prompts.
OfflineInstallerRollbarToken is the token used by the Offline Installer to talk to rollbar.
OptinBuildscriptsConfig is the config key used to determine whether the user has opted in to buildscripts.
OptinUnstableEnvVarName is used to instruct State Tool to opt-in to unstable features.
OverrideSandbox is the environment variable to set when overriding the sandbox for integration tests.
OverrideSessionTokenEnvVarName overrides SessionTokenEnvVarName for integration tests.
OverrideShellEnvVarName is the environment variable to set when overriding the shell for shell detection.
OverwriteDefaultInstallationPathEnvVarName is the environment variable name to overwrite the default installation path FOR TESTING PURPOSES ONLY.
OverwriteDefaultSystemPathEnvVarName is the environment variable name to overwrite the system app installation directory updates FOR TESTING PURPOSES ONLY.
PipShim is the name of the pip shim.
PlatformMarketingPage links to the marketing page for the ActiveState Platform.
PlatformPrivateNamespace is the namespace for private packages.
PlatformSignupPath is the account creation path used by the platform.
PlatformURL is the base domain for the production platform.
PreferredGlibcVersionConfig is the config key used to determine the preferred glibc version.
PrivateKeyEnvVarName is the name of the environment variable that specifies the private key file to use for decrypting secrets (overriding user config).
ProfileEnvVarName is the name of the environment variable that specifies whether profiling should be run.
RCAppendAutostartStartLine is the start line used to denote our autostart executables in RC files.
RCAppendAutostartStartLine is the end line used to denote our autostart executables in RC files.
RCAppendDefaultStartLine is the start line used to denote our default environment config in RC files.
RCAppendDefaultStopLine is the end line used to denote our default environment config in RC files.
RCAppendDeployStartLine is the start line used to denote our deploy environment config in RC files.
RCAppendDeployStopLine is the end line used to denote our deploy environment config in RC files.
RCAppendInstallStartLine is the start line used to denote our default installation config in RC files.
RCAppendInstallStopLine is the end line used to denote our default installation config in RC files.
RCAppendOfflineInstallStartLine is the start line used to denote our deploy environment config in RC files.
RCAppendOfflineInstallStopLine is the end line used to denote our deploy environment config in RC files.
ReleaseChannel is the channel used for release builds.
ReportAnalyticsConfig is the config key used to determine if we will send analytics reports.
ReportErrorsConfig is the config key used to determine if we will send rollbar reports.
RequirementsImportAPIPath is the path used for the requirements import api.
RubyExecutable represents the ActivePerl executable.
SecretsAPIPath is the api path used for the secrets api.
SecretsURL is the host used for secrets api calls when on production.
SecurityPromptConfig is the config key used to determine if we will prompt the user for security related actions.
SecurityPromptLevelConfig is the config key used to determine the level of security prompts.
ServiceCommandName holds the name of our service command.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServiceSockDir overrides the default socket path root diriectory used by the state service.
SessionTokenEnvVarName records the session token.
ShimEnvVarName is used to instruct State Tool that it's being executed as part of a shim.
StateAppName is the name we give our state cli executable.
StateCmd is the name of the state tool binary.
StateExecutorCmd is the name of the state executor binary.
StateInstallerCmd is the name of the state installer binary.
StateInstallerRollbarToken is the token used by the State Installer to talk to rollbar Todo It is currently the same as the State Tool's.
StateRemoteInstallerCmd is the name of the state remote installer binary.
StateServiceRollbarToken is the token used by the State Service to talk to rollbar.
StateSvcCmd is the name of the state-svc binary.
StateToolMarketingPage links to the marketing page for the state tool.
StateToolRollbarToken is the token used by the State Tool to talk to rollbar.
SvcAppName is the name we give our state-svc application.
SvcAuthPollingRateEnvVarName is used to override the default polling rate for syncing the authenticated state with the svc.
SvcLaunchFileName is the name we give files pertaining to our state-svc application.
StateSvcLogRotateInvervalEnvVarName is the environment variable used to override the default log rotation timer interval (1 minute).
TerminalAnimationInterval is the interval we use for terminal animations.
TermsOfServiceURLLatest is the URL to get the latest terms of service in PDF form.
TestAutoUpdateEnvVarName is used to test auto updates, when set to true will always attempt to auto update.
UnstableConfig is the config key used to determine whether the user has opted in to unstable commands.
UpdateChannelEnvVarName is the env var that is used to override which channel to pull the update from.
UpdateTagEnvVarName.
UserAgentTemplate is the template used to generate the actual user agent, which includes runtime information as well as build information.
{OS}Bit{Depth}UUID constants are the UUIDs associated with the relevant OSes in the platform DB and leveraged by the Dashboard (PlatformMapping).
VulnerabilitiesAPIPath is the path used for the vulnerabilities api.
{OS}Bit{Depth}UUID constants are the UUIDs associated with the relevant OSes in the platform DB and leveraged by the Dashboard (PlatformMapping).