• Table of contents
• Commands
  • Commands List
  • Commands details
    • Analyze
    • Build
    • Check
    • Create
    • Delete
    • Generate
    • Help
    • List
    • Merge
    • Pull
    • Push
    • Tag
    • Update
    • Optimize
    • Refresh

Commands¶

Commands List¶

• Analyze
  • analyse a repository - create tool and products
• Build
  • build a given environment
• Check
  • check environment
• Create
  • create a tool, a label, a product or an environment
• Delete
  • delete a tool, a label, a product or an environment
• Generate
  • generate doc or all products file
• Help
  • give help on commands or sub commands
• List
  • list tools, products, environments, builds, needs
• Merge
  • merge environments
• Pull
  • pull an environment, tool, an environment or tool conf file
• Push
  • push an environment, tool, an environment or tool conf file
• Tag
  • tag en environment
• Update
  • fetch tools
• Optimize
  • optimize product files
• Refresh
  • recalculate product graph

Commands details¶

Analyze¶

analyse a repository - create tool and products

• Hg
  • analyze a mercurial repository
  • Example(s) :
    • pem analyze hg URI

Build¶

build a given environment

• build an environment
• Example(s) :
  • pem build env_name -d /repo

Check¶

check environment

• Env
  • recalculate bashrc files for an environment
  • Example(s) :
    • pem check env env_name -d /repo

Create¶

create a tool, a label, a product or an environment

• Env
  • create an environment
  • Example(s) :
    • pem create env env_name -d /repo
      create a tool, a label, a product or an environment
• Product
  • create a product
  • Example(s) :
    • pem create product prod_name -d /repo
      create a tool, a label, a product or an environment
• Tool
  • create a tool
  • Example(s) :
    • pem create tool tool_name -d /repo
      create a tool, a label, a product or an environment
• Tools_4
  • create an environment to dev with a given tool
  • Example(s) :
    • pem create tools_4 tool_name -d /repo
      create a tool, a label, a product or an environment
• From
  • create an environment from a given tool
  • Example(s) :
    • pem create from tool_name -d /repo
      create a tool, a label, a product or an environment
• Label
  • create a label for a given environment
  • Example(s) :
    • pem create label name value env_name -d /repo

Delete¶

delete a tool, a label, a product or an environment

• Env
  • delete an env
  • Example(s) :
    • pem delete env env_name -d /repo
      delete a tool, a label, a product or an environment
• Product
  • delete a product with it's childs
  • Example(s) :
    • pem delete old env_name 3d -d /repo
      delete a tool, a label, a product or an environment
• Tool
  • delete a tool - check that no env depends on it
  • Example(s) :
    • pem delete tool tool_name -d /repo
      delete a tool, a label, a product or an environment
• Builds
  • delete oldests builds for a given environment
  • Example(s) :
    • pem delete builds env_name # -d /repo
      delete a tool, a label, a product or an environment
• Old
  • delete old environments
  • Example(s) :
    • pem delete old -d /repo
      delete a tool, a label, a product or an environment
• Errors
  • delete tools and environments in error - ie incomplete build
  • Example(s) :
    • pem delete errors -d /repo -a x86_64 -di Debian-jessie
      delete a tool, a label, a product or an environment
• Unreferenced
  • delete tool build not referenced by any environment
  • Example(s) :
    • pem delete unreferenced -a x86_64 -d /repo -di Debian-jessie
      delete a tool, a label, a product or an environment
• Label
  • remove a label from an environment
  • Example(s) :
    • pem delete label name env_name -d /repo

Generate¶

generate doc or all products file

• Doc
  • generate documentation in wiki format - second optionnal argument can be a file
  • Example(s) :
    • pem generate doc
      generate doc or all products file
• File
  • generate graph file containing all products
  • Example(s) :
    • pem generate file

Help¶

give help on commands or sub commands

• help cmd
• Example(s) :
  • pem help
    pem help cmd
    pem help sub_cmd

List¶

list tools, products, environments, builds, needs

• Tools
  • list all tools
  • Example(s) :
    • pem list tools -d /repo
      list tools, products, environments, builds, needs
• Errors
  • list errors in a given env
  • Example(s) :
    • pem list errors -d /repo -a x86_64 -di Debian-jessie
      list tools, products, environments, builds, needs
• Unreferenced
  • list unreferenced tools' build
  • Example(s) :
    • pem list unreferenced -d /repo -a x86_64 -di Debian-jessie
      list tools, products, environments, builds, needs
• Products
  • list products in an env
  • Example(s) :
    • pem list products -d /repo
      list tools, products, environments, builds, needs
• Envs
  • list envs
  • Example(s) :
    • pem list envs -d /repo | pem list envs -d /repo -la users=dev
      list tools, products, environments, builds, needs
• Builds
  • list builds available for a given environment
  • Example(s) :
    • pem list builds env_name -d /repo
      list tools, products, environments, builds, needs
• Old
  • list old env instantiations
  • Example(s) :
    • pem list old env_name 3d -d /repo
      list tools, products, environments, builds, needs
• Tag
  • list tag for a givent environment
  • Example(s) :
    • pem list tag env_name -d /repo
      list tools, products, environments, builds, needs
• Systems
  • list arch/distrib couple available
  • Example(s) :
    • pem list systems -d /repo
      list tools, products, environments, builds, needs
• Need
  • list need values for a given env
  • Example(s) :
    • pem list need env_name

Merge¶

merge environments

• merge environments
• Example(s) :
  • pem merge env_1 env_2 env_3 --name new_env

Pull¶

pull an environment, tool, an environment or tool conf file

• Env
  • pull environment directories and files - tools's build included
  • Example(s) :
    • pem pull env env_name -d /repo -u https://server:port -s server:another_port -a x86_64 -di Debian-jessie
      pull an environment, tool, an environment or tool conf file
• Envconf
  • pull env product file
  • Example(s) :
    • pem pull envconf env_name -d /repo -u https://server:port -s server:another_port
      pull an environment, tool, an environment or tool conf file
• Tool
  • pull tool dir - no repo included
  • Example(s) :
    • pem pull tool tool_name -d /repo -u https://server:port -s server:another_port

Push¶

push an environment, tool, an environment or tool conf file

• Env
  • push environment directories and files - tools's build included
  • Example(s) :
    • pem push env env_name -d /repo -s server:another_port -a x86_64 -di Debian-jessie
      push an environment, tool, an environment or tool conf file
• Envconf
  • push env product file
  • Example(s) :
    • pem push envconf env_name -d /repo -s server:another_port
      push an environment, tool, an environment or tool conf file
• Tool
  • push tool dir - no repo included
  • Example(s) :
    • pem push tool tool_name -d /repo -s server:another_port

Tag¶

tag en environment

• tag an evironment
• Example(s) :
  • pem tag env_name ID tag_name -d /repo

Update¶

fetch tools

• Tool
  • fetch last version of tool
  • Example(s) :
    • pem update tool tool_name -d /repo
      fetch tools
• Pem
  • fetch last pem version
  • Example(s) :
    • pem update pem -d /repo -s server:another_port

Optimize¶

optimize product files

• minimize product files
• Example(s) :
  • pem optimize tool_name -d /repo

Refresh¶

recalculate product graph

• recalculate product file
• Example(s) :
  • pem refresh env_name -d /repo