Skip to content

Home

Jump to bottom
Alex Laird edited this page May 29, 2018 · 32 revisions

This documentation should give better insight into the helium-cli, how it works, and how it can be customized and used in your own projects. To get started, have a look at the Installation and Configuration page, then move on to other pages to better understand the commands that come with this tool.

For further example usage, see Helium's deploy project, which utilizes this tool.

Default Project Structure

By default, this tool assumes a directory structures as follows:

  • root repo
    • .gitignore (should contain at least /projects)
    • ansible
      • group_vars all.yml
      • `hosts
        • env1
        • env2
      • <env1>.yml
      • <env2>.yml
    • projects (do not commit, as helium-cli manages this directory)
      • proj1
      • proj2

The assumption is that the root repository contains a valid Ansible project

When the command helium-cli update-projects is first run, projects will be populated by cloning all repos of HELIUMCLI_GIT_PROJECT matching a project name in the HELIUMCLI_PROJECTS list. So, for example, HELIUMCLI_GIT_PROJECT defaults to https://github.com/HeliumEdu and HELIUMCLI_PROJECTS defaults to ["platform", "frontend"].

This default project structure can be override by modifying the path-related environment variables, as defined here, prior to installing helium-cli in your project.

Clone this wiki locally