pi workspace edit

Command Help

> pi ws edit -h
Usage: pi workspace edit [-h] [--wsdir WSDIR] [--template TEMPLATE] 
                         [--force] [--keep-local] [--promote]
                         [--unload <unload_mode>] [discard] [ip]

Description: Edit the Workspace IP. The command puts the Workspace IP
specification into a temporary file and invokes the editor specified by the
EDITOR environment variable. Saving the file updates the Workspace IP.

Positional arguments:
  ip               The IP to update. By default, the top IP of the
                   Workspace will be used.

Optional arguments:
  --force, -f      Update a Workspace to precisely reflect the template.
                   All resources are updated to the version in the
                   template.
  --keep-local, -k Update the Workspace to the template, while retaining
                   changes that had already been made to files and
                   resources.
  --promote, -p    Update the Workspace to the template, unless the
                   Workspace already has a version of a resource that is
                   greater than the version in the template. In that
                   case, the version of the resource already in the
                   Workspace. This is the default behavior.
  --template TEMPLATE, -t TEMPLATE
                   Use the specified template to edit the Workspace IP.
                   The template is an ASCII file that defines the
                   Workspace IP. This can be used to edit Workspace IP
                   with a script and avoid the interactive editor. To
                   read the template from STDIN, set TEMPLATE='-'.
  --unload MODE    Specify handling of IPVs that will be unloaded from the workspace. 
	            MODE is integer 0-2:
			0 (default) - block unload for open files,
			1 - block unload for open+modified files (unmodified files will be reverted),			
			2 - same as 1 but unopened modified files will be backed up to BACKUP_DIR. 	
			Higher mode number gives lower performance 
  --wsdir WSDIR, -ws WSDIR
                   The Workspace directory. If not specified, the current
                   directory should be a Workspace directory.
  -h, --help Show this help message and exit

Examples

# Invoke the editor to modify the top IP of the workspace. 
pi workspace edit 
# Invoke the editor to modify IP mmu of the workspace. 
pi workspace edit mmu
# Modify IP mmu of the workspace using the mmu.info template. 
pi workspace edit -t mmu.info mmu 
# Modify IP mmu of the workspace using redirected STDOUT from script
# edit_ws.py as template.
edit_ws.py | pi workspace edit -t - mmu