Git Product home page Git Product logo

go-command-repo's Introduction

A command repository for Go

Introduction

The newly introduced command repository hosts a selection of commands to help you get started with various tools via Go's custom command. This Readme describes syntax of a command and the structure of the repository. For full documentation about Go's support for this feature, please see:

http://www.thoughtworks.com/products/docs/go/current/help/command_repository.html

Also check out these articles explaining how this can be used.

Introductory: And you thought Go didn't support Maven, Nuget or Chef?

Advanced: Use Go's new command repository to lookup your config scripts

Caution: Please do not change/add anything under the default repo on the Go server. The directory will be deleted and re-created upon Go Server upgrade. Refer the above link for setting up your own private command repository.

Version.txt

Go Server bundles a clone of the repository at https://github.com/goteam/go-command-repo by default. The version.txt file is meant to allow conditional overwriting of the repository during server upgrades.

Command Syntax

A valid command file looks like this:

<exec command="curl">
  <arg>-u</arg>
  <arg>user:password</arg>
  <arg>http://targeturl</arg>
</exec>

It must be a valid .xml file (escape special characters). The command attribute is mandatory. No other attributes are valid. Zero or more arg child elements can be specified. No other child elements are allowed. One command file may only contain one command.

Command Documentation

Documentation is fully optional but it aids lookup and use if present. Here is the above command with full documentation. Each item of documentation is key:value. Only whitespace characters may precede a key. Value terminates with newline (no multi-line values). Descriptions longer than about 250 characters may get truncated in the admin GUI on the Go Server.

note: author refers to author of the command xml file, not the underlying tool :-)

<!--
  name: curl
  description: curl is a command line tool for transferring data with URL syntax
  keywords: curl, wget, download, httpclient
  moreinfo: http://curl.haxx.se/docs/manpage.html
  author: Go Team
  authorinfo: http://support.thoughtworks.com/categories/20002778-go-community-support
-->
<exec command="curl">
  <arg>-u</arg>
  <arg>user:password</arg>
  <arg>http://targeturl</arg>
</exec>

go-command-repo's People

Contributors

goteam avatar arvindsv avatar rajeshvaran avatar sriki77 avatar bagheera avatar johncmckim avatar jyotisingh avatar srinivasupadhya avatar

Watchers

Sam Jones avatar James Cloos avatar Peter Riesz avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.