shell

Documentation

Overview

Package shell holds the sourced shim templates and helpers for emitting shell-appropriate environment statements.

Index

• Variables
• func ExportStatement(shellName, key, value string) string
• func Init(name string) (string, error)
• func UnsetStatement(shellName, key string) string

Variables

var Supported = []string{"bash", "zsh", "fish"}

Supported shells for `gcloudenv init`.

Functions

func ExportStatement

func ExportStatement(shellName, key, value string) string

ExportStatement renders "set VAR to value" in the syntax of the target shell. shellName "fish" uses `set -gx`; everything else uses POSIX `export`.

func Init

func Init(name string) (string, error)

Init returns the integration snippet to be sourced for the given shell. bash and zsh share a template.

func UnsetStatement

func UnsetStatement(shellName, key string) string

UnsetStatement renders a statement that removes VAR from the environment. shellName "fish" uses `set -e`; everything else uses POSIX `unset`.