Command Reference

SCM Support

git is the only supported SCM. If you have a svn repo, check it out with git-svn.

Setting Up Your Workspace

It is optional to run ‘wst setup’, however it is recommended as you can type less to do what you want.

After running setup, bash functions and aliases are created for all wst commands. I.e. It creates “ci” alias for “wst commit” if the -a option is used (–commands-with-aliases). And for some commands (such as push), it also adds auto complete for branch name.

To setup, simply go to your workspace directory, and then run ‘wst setup’ with the apporpriate options (-a is recommended):

wst setup -a

For the sake of readability for the first time user, the remaining reference will use the full wst command instead of aliases from setup. But reference to the short version may be provided as a comment.

Checkout a Repository

To checkout a product, there are two ways:

1. Use an URL:

   wst checkout https://github.com/maxzheng/workspace-tools.git
   
   # Or after "wst setup -a": co https://github.com/maxzheng/workspace-tools.git
   

2. Use a product group (see Configuration for more info):

   wst checkout mzheng-repos
   

Customize Commands

As simple as two steps:

1. Create your own controller by copying workspace/controller.py:main and add entrypoint to setup.py
2. Add your own commands or change existing in controller. See workspace.commands package for examples.

TBD for better docs.

Want More Docs?

Most commands have help info, so run the command with ‘-h’.

Bump is based on bumper, so read its doc to learn more.

TBD for more docs as I am not sure if anyone actually read this since there probably aren’t that many users of workspace-tools. So If you would like to read the rest of the docs, let me know (maxzheng.os @t gmail.com), and I will take the time to finish this.