Documentation
¶
Overview ¶
gosh is a proof of concept shell built on top of interp.
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Example (ExtractUsage) ¶
markdown, _ := GetMarkDown("base64")
fmt.Println(len(ExtractUsage(markdown)))
Output: 40
Example (Markdown2text) ¶
markdown, _ := GetMarkDown("base64")
fmt.Println(len(MarkdownToText(markdown)))
Output: 697
Index ¶
- Variables
- func DateFmtTool(args []string) error
- func Empty() (int, error)
- func Executable() (int, error)
- func ExpBackoffRetry(args []string) error
- func Extract() (int, error)
- func ExtractFileFromCompressedTar(filename string, target string) error
- func ExtractFileFromZip(filename string, target string) error
- func ExtractUsage(input string) string
- func Filetype() error
- func GetARCH() string
- func GetMarkDown(toolName string) (string, error)
- func GetOS() string
- func Help(mainTools []string)
- func IsTool(name string) bool
- func MarkdownHelp(toolName string) string
- func MarkdownToText(input string) string
- func MergeToolsList(mainTools []string) []string
- func OpsPath() (int, error)
- func RandTool(args ...string) error
- func Remove() (int, error)
- func Rename() (int, error)
- func RunTool(name string, args []string) (int, error)
- func Sh() (int, error)
- func URLEncTool() error
- func Wsk(command []string, args ...string) error
- type Tool
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var T goi18n.TranslateFunc
var ToolList = []Tool{ {"wsk", false}, {"awk", false}, {"jq", false}, {"sh", true}, {"envsubst", false}, {"filetype", true}, {"random", true}, {"datefmt", true}, {"die", false}, {"urlenc", true}, {"replace", false}, {"base64", true}, {"validate", true}, {"echoif", true}, {"echoifempty", true}, {"echoifexists", true}, {"needupdate", true}, {"gron", false}, {"jj", false}, {"rename", true}, {"remove", true}, {"executable", true}, {"empty", true}, {"extract", true}, {"opspath", true}, }
available in taskfiles note some of them are implemented in main.go (config, retry) Note the comment with @DOC which is used to generate the list of tools in documentation put one here if you add a markdown file for a tool
var Tools = []string{
"awk", "die", "jq", "js",
"envsubst", "wsk", "mkdir",
"filetype", "random", "datefmt",
"config", "retry", "urlenc",
"replace", "base64", "validate",
"echoif", "echoifempty", "echoifexists",
"realpath", "zipf", "needupdate",
"gron", "jj", "deploy",
}
Functions ¶
func DateFmtTool ¶
func Executable ¶
func ExpBackoffRetry ¶
func ExtractFileFromZip ¶
func ExtractUsage ¶
func GetMarkDown ¶
func MarkdownHelp ¶
func MarkdownToText ¶
func MergeToolsList ¶
Example ¶
mergedList := MergeToolsList([]string{})
fmt.Println(len(mergedList))
Output: 25
func URLEncTool ¶
func URLEncTool() error
Example ¶
os.Args = []string{"urlenc", "p@ss", "w&rd"}
fmt.Println(URLEncTool())
os.Args = []string{"urlenc", "-s=:", "p@ss", "w&rd"}
fmt.Println(URLEncTool())
os.Setenv("PASS", "p@ass")
os.Args = []string{"urlenc", "-e", "PASS", "WORD"}
fmt.Println(URLEncTool())
Output: p%40ss&w%26rd <nil> p%40ss:w%26rd <nil> p%40ass& <nil>
Source Files