Checkout the given project and setup its runtime
Usage
state checkout [flags] <org/project> <path>
Arguments
<org/project> The namespace of the project that you wish to checkout, or the path to a project
archive (.tar.gz) to checkout<path> (optional) Where to checkout the project. If not given, the project is checked out to a
sub-folder in the current working directoryFlags
--branch Defines the branch to checkout--runtime-path Path to store the runtime files--portable Copy files to their runtime path instead of linking to them--no-clone Do not clone the github repository associated with this project (if any)--force, -f Leave a failed project checkout on disk; do not delete itCommit changes to the Build Script
Usage
state commit [flags]
Flags
--ts The timestamp at which you want to query. Can be either ‘now’ (bleeding edge), ‘present’
(platform present), ‘dynamic’ (pull in ingredients as needed), or RFC3339 formatted timestamp.--skip-validation, -s Skip validation of the changes. This will allow you to commit even if
there are issues resolving the buildscript. This will also skip CVE lookups.Initialize a new project
Usage
state init [flags] <org/project> <path>
Arguments
<org/project> (optional) The namespace for the project that you wish to initialize. If not in
the format of <org/project>, the value will be used as the project name.<path> (optional) Where to initialize the projectFlags
--language The Language[@version] that this project should use--private Create a private projectSwitch to a branch, commit, or tag
Usage
state switch <identifier>
Arguments
<identifier> The commit or branch to switch toIntercept and run a script via a project runtime environment
Usage
state exec [flags]
Flags
--path The path of the project that you want to use the runtime environment of. If no path is
given the current working directory is used.Updates the given project runtime based on its current configuration
Usage
state refresh <org/project>
Arguments
<org/project> (optional) The namespace of the project to update, or just the project name if
previously usedStarts a shell/prompt in a virtual environment for the given project runtime
Usage
state shell [flags] <org/project>
Arguments
<org/project> (optional) The namespace of the project you wish to start a virtual environment
shell/prompt for, or just the project name if previously usedFlags
--cd Change to the project directory after starting virtual environment shell/promptUse the given project as your default. This configures it globally in all your shells, and makes State Tool default to it if not other project was found.
Usage
state use <org/project or project>
Arguments
<org/project or project> (optional) The fully qualified namespace (org/project) or just the
project name (project) of the project to use. Must have been previously checked out using ‘state
checkout’.Stop using your project runtime
Usage
state use reset
Show the project runtime you are using
Usage
state use show
Activate a project
Usage
state activate [flags] <org/project>
Arguments
<org/project> (optional) The namespace of the project that you wish to activateFlags
--path Where to install the project--default Configures the project to always be available for use--branch Defines the branch to be usedList your projects
Usage
state projects
Delete the specified project from the Platform
Usage
state projects delete <namespace>
Arguments
<namespace> org/projectEdit the project details for the specified project
Usage
state projects edit [flags] <namespace>
Arguments
<namespace> The namespace of the project to editFlags
--name Edit the name of the project.--visibility Edit the visibility to non-members, either public or private.--repository Edit the linked VCS repo. To unset use –repo=”".Move the specified project to another organization
Usage
state projects move <org/project> <new-org-name>
Arguments
<org/project> The project to move<new-org-name> The organization to move the project toList all projects, including ones you have not checked out locally
Usage
state projects remote
Run your project scripts
Usage
state run <script>
Arguments
<script> Name of script to runShow information about a project
Usage
state show <remote>
Arguments
<remote> (optional) Namespace of remote projectInspect artifacts created for your project
Usage
state artifacts [flags]
Flags
--all List all artifacts, including individual package artifacts--namespace The namespace of the project to inspect artifacts for--commit The commit ID to inspect artifacts for--target The target to report artifacts for--full-id List artifacts with their full identifierDownload build artifacts for a given build
Usage
state artifacts dl [flags] <ID> <path>
Arguments
<ID> The ID of the artifact to download<path> (optional) The target path to download the artifact toFlags
--namespace The namespace of the project to download artifacts from--commit The commit ID to download artifacts from--target The target to download artifacts fromManage bundles used in your project
Usage
state bundles [flags]
Flags
--commit The commit that the listing should be based on--bundle The filter for the bundles names to include in the listing--namespace The namespace bundles should be listed fromAdd a new bundle to your project
Usage
state bundles install <name[@version]>
Arguments
<name[@version]> Bundle name and optionally the desired versionSearch for all available bundles that can be added to your project
Usage
state bundles search [flags] <name>
Arguments
<name> Bundle nameFlags
--language The language used to constrain search results--exact-term Ensure that search results match search term exactlyRemove bundle from your project
Usage
state bundles uninstall <name>
Arguments
<name> Bundle nameImport packages from a list of dependencies
Usage
state import [flags] <File>
Arguments
<File> The file to importFlags
--language The language we’re importing data from, this determines the format of the import.
Leave blank to auto-detect based on filename.--namespace The namespace targeted for the import. Leave blank to auto detect based on
filename.--ts The timestamp at which you want to query. Can be either ‘now’ (bleeding edge), ‘present’
(platform present), ‘dynamic’ (pull in ingredients as needed), or RFC3339 formatted timestamp.Display information for the specified package
Usage
state info [flags] <name[@version]>
Arguments
<name[@version]> Package name and optionally the desired versionFlags
--language The language used to constrain package information selection--ts The timestamp at which you want to query. Can be either ‘now’ (bleeding edge), ‘present’
(platform present), ‘dynamic’ (pull in ingredients as needed), or RFC3339 formatted timestamp.Add a new package to your project
Usage
state install [flags] <name[@version]>
Arguments
<name[@version]> Package name and optionally the desired version. The version may contain
wildcards, for example: ‘1.0.x’.Flags
--ts The timestamp at which you want to query. Can be either ‘now’ (bleeding edge), ‘present’
(platform present), ‘dynamic’ (pull in ingredients as needed), or RFC3339 formatted timestamp.List the requirements of the current project
Usage
state manifest [flags]
Flags
--expand Expand requirement names to include their namespaceList packages used in your project
Usage
state packages [flags]
Flags
--commit The commit that the listing should be based on--package The filter for package names to include in the listing--namespace The namespace packages should be listed fromSearch for available packages that can be added to your project
Usage
state search [flags] <name>
Arguments
<name> Package name, optionally with namespace, eg. ‘[Flags
--language The language used to constrain search results--exact-term Ensures that search results match search term exactly--ts The timestamp at which you want to query. Can be either ‘now’ (bleeding edge), ‘present’
(platform present), ‘dynamic’ (pull in ingredients as needed), or RFC3339 formatted timestamp.Remove a package from your project
Usage
state uninstall <name>
Arguments
<name> Package name, optionally with namespace, eg. ‘[Upgrade dependencies of a project
Usage
state upgrade [flags]
Flags
--ts Manually specify the timestamp to ‘upgrade’ to. Can be either ‘now’ or RFC3339 formatted
timestamp.--expand Show individual transitive dependency changes rather than a summaryAuthenticate against the ActiveState Platform
Usage
state auth [flags]
Flags
--token The API Token generated via the ActiveState Platform (http://docs.activestate.com/platform/state/ci.html#authenticate-without-prompts-or-passwords)--username The username to authenticate with--password The password to authenticate with--totp The TOTP code generated via two-factor authentication (must be used in conjunction with
username and password flags)--prompt Sign in via your terminal, rather than your web browser.Logout
Usage
state auth logout
Signup a new account
Usage
state auth signup
Manage your project’s branches
Usage
state branch
Invite new members to an organization
Usage
state invite [flags] <email1[,email2,..]>
Arguments
<email1[,email2,..]> Email addresses to send the invitations toFlags
--organization Organization to invite to. If not set, invite to current project’s organization--role Set user role to ‘member’ or ‘owner’. If not set, prompt for the roleView the languages of a project
Usage
state languages
Update the language of a project
Usage
state languages install <language>
Arguments
<language> The language to update in the form of Search for an available language to use in your project
Usage
state languages search
List member organizations on the ActiveState Platform
Usage
state organizations
Manage platforms used in your project
Usage
state platforms
Add a new platform to your project
Usage
state platforms add [flags] <name>
Arguments
<name> Name[@Flags
--bit-width Platform architecture word size/width in bits (32,64)Remove a platform from your project
Usage
state platforms remove [flags] <name>
Arguments
<name> Name[@Flags
--bit-width Platform architecture word size/width in bits (32,64)Search for available platforms that can be added to your project
Usage
state platforms search
Manage your secrets
Usage
state secrets [flags]
Flags
--filter-usedby Show only secrets that match the given filter. The filter value is the config
path that you want to see secrets for, eg. constants.foo, scripts.foo, secrets.project.foo, etc.Get the value of a secret
Usage
state secrets get <namespace>
Arguments
<namespace> Namespace of secret is ‘SCOPE.NAME’. eg. ‘user.mySecret’ or ‘project.ourSecret’Set the value of a secret
Usage
state secrets set <namespace> <secret-value>
Arguments
<namespace> Namespace of secret is ‘SCOPE.NAME. eg. ‘user.mySecret’ or ‘project.ourSecret’<secret-value> Value of unencrypted SecretSynchronize your shareable secrets to everyone in the organization for the current project
Usage
state secrets sync
Show a summary of project vulnerabilities
Usage
state security <org/project>
Arguments
<org/project> (optional) The project for which the report is createdOpen the given vulnerability details in your browser
Usage
state security open <ID>
Arguments
<ID> (optional) The vulnerablility to open in your browserEvaluate a buildscript target
Usage
state eval <target>
Arguments
<target> The target to evaluatePublish an Ingredient for private consumption.
Usage
state publish [flags] <filepath>
Arguments
<filepath> (optional) A tar.gz or zip archive containing the source files of the ingredient.Flags
--edit Create a revision for an existing ingredient, matched by their name and namespace.--editor Edit the ingredient information in your editor before uploading.--name The name of the ingredient. Defaults to basename of filepath.--version Version of the ingredient (preferably semver).--namespace The namespace of the ingredient. Must start with ‘private/--description A short description summarizing what this ingredient is for.--author Ingredient author, in the format of “[--depend Ingredient that this ingredient depends on. Format as --depend-runtime Ingredient that this ingredient depends on during runtime. Format as
--depend-build Ingredient that this ingredient depends on during build. Format as
--depend-test Ingredient that this ingredient depends on during tests. Format as
--feature Feature that this ingredient provides. Format as --meta A yaml file expressing the ingredient meta information. Use –editor to review the file
format.Fork an existing ActiveState Platform project
Usage
state fork [flags] <org/project>
Arguments
<org/project> The namespace of the project to be forkedFlags
--org The organization to fork the project to--name The name of the new project to be created--private Denotes if the forked project will be privateView history of the active project
Usage
state history
Pull in the latest version of your project from the ActiveState Platform
Usage
state pull
Push your latest changes to the platform
Usage
state push <org/project>
Arguments
<org/project> (optional) The project to push to (uses project under current dir otherwise).Reset local checkout to a particular commit.
Usage
state reset <CommitID>
Arguments
<CommitID> (optional) Reset to the given commit. If not specified, resets local checkout to be
equal to the project on the platformRevert a commit
Usage
state revert [flags] <commit-id>
Arguments
<commit-id> The commit ID to revert changes from, or HEAD for the latest commitFlags
--to Create a new commit that brings the runtime back to the same state as the commit givenManage project events
Usage
state events
View a log of events
Usage
state events log [flags]
Flags
--follow Don’t stop when end of file is reached. Wait for additional data.Show project scripts
Usage
state scripts
Edit a given script
Usage
state scripts edit [flags] <name>
Arguments
<name> The name of the script to be editedFlags
--expand, -e Whether or not to expand constants within the scriptClean caches, configuration files, or completely remove the state tool
Usage
state clean
Removes cached Runtime Environments
Usage
state clean cache <org/project>
Arguments
<org/project> (optional) The project to be removed from the local cache.Removes global State Tool configuration. Project configuration will not be affected.
Usage
state clean config
Remove the State Tool, installed languages, and any configuration files
Usage
state clean uninstall [flags]
Flags
--all, -a Also delete all associated config and cache files--prompt Asks the user if everything should be deleted or to keep cache and configManage the State Tool configuration
Usage
state config
Print config values to the terminal
Usage
state config get <key>
Arguments
<key> Config keySet config values using the terminal
Usage
state config set <key> <value>
Arguments
<key> Config key<value> Config valuePrint information based on the provided subcommand
Usage
state export
Export the build plan for your project
Usage
state export buildplan [flags]
Flags
--namespace The namespace of the project to export the build plan for--commit The commit ID to export the build plan for--target The target to export the build plan forExport state tool configurations
Usage
state export config [flags]
Flags
--filter Filter configuration output. Accepts: dirExport the environment variables associated with your runtime.
Usage
state export env
Create a github action workflow for your project
Usage
state export github-actions
Print jwt credentials
Usage
state export jwt
Show the path to a State Tool log file
Usage
state export log [flags] <prefix>
Arguments
<prefix> (optional) The prefix of the log file to show (e.g. state or state-svc). The default is ‘state’Flags
--index, -i The 0-based index of the log file to show, starting with the newestCreate and print new API key
Usage
state export new-api-key <name>
Arguments
<name> API key nameExports the private key. This is useful if you want to set it via environment variable (ACTIVESTATE_PRIVATE_KEY)
Usage
state export private-key
Export the runtime associated with your runtime.
Usage
state export runtime <path>
Arguments
<path> (optional) Optional path to your project’s runtime if not inside your projectRead the State Tool cheat sheet to learn about common commands
Usage
state learn
Updates the State Tool to the latest available version
Usage
state update [flags]
Flags
--set-channel Switches to the given update channel, eg. ‘release’.Lock the State Tool at the current version. This disables automatic updates.
Usage
state update lock [flags]
Flags
--set-channel Switches to the given update channel, eg. ‘release’.Unlock the State Tool version for the current project.
Usage
state update unlock