terraform/website/docs/cli/commands/workspace/new.html.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

---
layout: "docs"
page_title: "Command: workspace new"
sidebar_current: "docs-commands-workspace-sub-new"
description: |-
The terraform workspace new command is used to create a new workspace.
---
# Command: workspace new
The `terraform workspace new` command is used to create a new workspace.
## Usage
Usage: `terraform workspace new [OPTIONS] NAME [DIR]`
This command will create a new workspace with the given name. A workspace with
this name must not already exist.
If the `-state` flag is given, the state specified by the given path
will be copied to initialize the state for this new workspace.
2021-01-26 17:34:48 +01:00
The command-line flags are all optional. The supported flags are:
* `-lock` - Lock the state file when locking is supported. Defaults to true.
* `-lock-timeout` - Duration to retry a state lock. Default 0s.
* `-state=path` - Path to an existing state file to initialize the state of this environment.
## Example: Create
```
$ terraform workspace new example
Created and switched to workspace "example"!
You're now on a new, empty workspace. Workspaces isolate their state,
so if you run "terraform plan" Terraform will not see any existing state
for this configuration.
```
## Example: Create from State
To create a new workspace from a pre-existing local state file:
```
$ terraform workspace new -state=old.terraform.tfstate example
Created and switched to workspace "example".
You're now on a new, empty workspace. Workspaces isolate their state,
so if you run "terraform plan" Terraform will not see any existing state
for this configuration.
```