Spread Commands · Redspread

{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Spread Commands","type":"basic","slug":"spread-commands","excerpt":"This page will give you an overview of Spread's current functionality.","body":"For a more in-depth look, see our [Godocs](https://godoc.org/rsprd.com/spread).\n\n###spread deploy\n**name** \n`spread deploy` - deploys all objects in a directory to a Kubernetes cluster\n\n**synopsis**\n`spread deploy [-s] PATH | COMMIT [kubectl context]1\n\n**description**\nDeploys all objects in a directory (local or remote) to a Kubernetes cluster\n\nThe order of operations for actions taken by `spread deploy`: \n* Reads context of directory and builds Kubernetes deployment hierarchy.\n* Updates all Kubernetes objects on a Kubernetes cluster.\n* Returns an IP address (remote) or port (local), if type Load Balancer is specified.\n\n###spread cluster\n\n**name**\n`spread cluster` - sets up a local Kubernetes cluster\n\n**synopsis**\n`spread cluster (start | stop) [-t]`\n\n**description**\nStarts and stops [localkube](http://github.com/redspread/localkube), a local Kubernetes cluster\n\n**options**\n-t \"latest\" specifies localkube image tag to use, default is latest\n\n###spread add\n\n**name** \n`spread add` - stage objects to the index\n\n**synopsis** \n`spread add <objectType/objectName>`\n\n**description** \nStage objects to the index\n\n**options** \n--namespace \"default\" namespace to look for objects \n--context kubectl context to use for requests \n--no-export don't request Kube API server to export objects\n\n###spread commit\n\n**name** \n`spread commit` - create new commit based on current index\n\n**synopsis** \n`spread commit -m <\"msg\">`\n\n**description** \nCreate new commit based on the current index and add a commit message\n\n**options** \n-m Message to store the commit with\n\n###spread push\n\n**name** \n`spread push` - Push references to a remote\n\n**synopsis** \n`spread push <remote> <refSpec>`\n\n**description** \nPush references to a remote\n\n###spread pull\n\n**name** \n`spread pull` - Pull spread data from a remote branch\n\n**synopsis** \n`spread pull <remote> <branch>`\n\n**description** \nIncorporates changes from a remote repository into the current branch. \n\n###spread remote\n\n**name** \n`spread remote` - View/modify versioning remotes\n\n**synopsis** \n`spread remote (add <name> <url> | remove <name> | set-url <name> <url>)`\n\n**description** \nManages repository remote\n\n**options** \n-m Message to store the commit with\n\n###spread diff\n\n**name** \n`spread diff` - diff index against the state of the cluster\n\n**description** \nDiffs index against the state of the cluster \n\n**options** \n--context kubectl context to use for requests\n\n\n###spread status \n\n**name** \n`spread status` \n\n**description** \nInformation about what's commited, changed, and staged.\n\n###spread init\n\n**name** \n`spread init` \n\n**synopsis**\n`spread init <path>` \n\n**description** \nCreate a new spread repository in the given directory. If none is given, the working directory will be used.\n\n###spread git \n\n**name** \n`spread git` - allows access to Git commands while Spread is being built out \n\n**description** \nAllows access to Git commands while Spread is being built out. \n\n**options** \n--context kubectl context to use for requests\n\n###spread link\n\n**name**\n`spread link` - create/remove links on index\n\n**synopsis**\n`spread link <target-url> <attach-point>`\n\n###spread param\n\n**name**\n`spread param` - Set parameters for field values in the index\n\n**synopsis**\n`spread param [-l | -f | -d] <SRI> <name> <prompt>`\n\n**options**\n `-l` list parameters\n `-f` set Golang format string to use with arguments\n `-d` set default value, interpreted as JSON\n\n**discussion**\nAn SRI represents a parsed Spread Resource Identifier (SRI), a globally unique address for an document or field stored within a repository.","updates":["5807db9d0c08ff0f00075d06"],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57acceed71d2991900b9a62e","version":{"version":"1.0.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["57acceed71d2991900b9a62c"],"_id":"57acceed71d2991900b9a62b","createdAt":"2016-08-11T19:15:57.383Z","project":"570086efa565e20e001573b3","releaseDate":"2016-08-11T19:15:57.383Z","__v":1},"createdAt":"2016-04-28T00:06:37.155Z","githubsync":"","__v":1,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"57acceed71d2991900b9a62c","version":"57acceed71d2991900b9a62b","project":"570086efa565e20e001573b3","createdAt":"2016-04-03T02:58:55.770Z","__v":0},"project":"570086efa565e20e001573b3","user":"569d7767ec29360d00f667c7"}

For a more in-depth look, see our [Godocs](https://godoc.org/rsprd.com/spread). ###spread deploy **name** `spread deploy` - deploys all objects in a directory to a Kubernetes cluster **synopsis** `spread deploy [-s] PATH | COMMIT [kubectl context]1 **description** Deploys all objects in a directory (local or remote) to a Kubernetes cluster The order of operations for actions taken by `spread deploy`: * Reads context of directory and builds Kubernetes deployment hierarchy. * Updates all Kubernetes objects on a Kubernetes cluster. * Returns an IP address (remote) or port (local), if type Load Balancer is specified. ###spread cluster **name** `spread cluster` - sets up a local Kubernetes cluster **synopsis** `spread cluster (start | stop) [-t]` **description** Starts and stops [localkube](http://github.com/redspread/localkube), a local Kubernetes cluster **options** -t "latest" specifies localkube image tag to use, default is latest ###spread add **name** `spread add` - stage objects to the index **synopsis** `spread add <objectType/objectName>` **description** Stage objects to the index **options** --namespace "default" namespace to look for objects --context kubectl context to use for requests --no-export don't request Kube API server to export objects ###spread commit **name** `spread commit` - create new commit based on current index **synopsis** `spread commit -m <"msg">` **description** Create new commit based on the current index and add a commit message **options** -m Message to store the commit with ###spread push **name** `spread push` - Push references to a remote **synopsis** `spread push <remote> <refSpec>` **description** Push references to a remote ###spread pull **name** `spread pull` - Pull spread data from a remote branch **synopsis** `spread pull <remote> <branch>` **description** Incorporates changes from a remote repository into the current branch. ###spread remote **name** `spread remote` - View/modify versioning remotes **synopsis** `spread remote (add <name> <url> | remove <name> | set-url <name> <url>)` **description** Manages repository remote **options** -m Message to store the commit with ###spread diff **name** `spread diff` - diff index against the state of the cluster **description** Diffs index against the state of the cluster **options** --context kubectl context to use for requests ###spread status **name** `spread status` **description** Information about what's commited, changed, and staged. ###spread init **name** `spread init` **synopsis** `spread init <path>` **description** Create a new spread repository in the given directory. If none is given, the working directory will be used. ###spread git **name** `spread git` - allows access to Git commands while Spread is being built out **description** Allows access to Git commands while Spread is being built out. **options** --context kubectl context to use for requests ###spread link **name** `spread link` - create/remove links on index **synopsis** `spread link <target-url> <attach-point>` ###spread param **name** `spread param` - Set parameters for field values in the index **synopsis** `spread param [-l | -f | -d] <SRI> <name> <prompt>` **options** `-l` list parameters `-f` set Golang format string to use with arguments `-d` set default value, interpreted as JSON **discussion** An SRI represents a parsed Spread Resource Identifier (SRI), a globally unique address for an document or field stored within a repository.