Skip to content

Provide a way to initialize a new project

At present, if one wants to start a new BuildStream project, one has to create a project.conf file which at least specifies the name of the project. And, it may not be immediately obvious to a new user that this is the case. Maybe we can provide a new bst init command (somewhat similar to git init) that would start a new BuildStream project in given directory. At the very least, it would fill out all required variables (we only have one at the moment though but this may change in future). We can also use this to drive best practices around project structures if so desire.

I was thinking that the init command should do something reasonable without requiring any extra arguments but one should be able to override default behavior using command-line arguments to this command. To begin with, we could provide options to configure some commonly-used variables, like these:

  • --name PROJECT_NAME: default to directory name
  • --element-path ELEMENT_PATH: default to current directory
  • --format-version FORMAT_VERSION: default to latest version

Thoughts?

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information