linode-stackscript man page

linode-stackscript — command-line interface for Linode StackScripts

Synopsis

linode-stackscript [-a action] [action-options...] [options...]

-a create, --action create    create a new StackScript

-a update, --action update    update a StackScript

-a delete, --action delete    delete a StackScript

-a list,   --action list      list info about StackScripts

-a show,   --action show      show detailed info about a StackScript

-a source, --action source    show a StackScript's source

           --api-key=KEY      your user's API key

-h,        --help             display this help and exit

-j,        --json             return output in JSON format

-u,        --username=USER    username for Linode CLI config file

Options

-a, --action

An action to perform on Linode StackScript(s). One of: create, update, delete, list, show, source.

--api-key

API key to use when communicating with the Linode API. The API key can also be set using an environment variable (LINODE_API_KEY). Alternatively, you can specify the API key in a .linodecli file in the working user's home directory, using the format `api-key foobar`.

-u, --username:

Optional. Allows users to specify the username, if using with multiple accounts and configuration files.

-j, --json:

Optional. JSON output.

-h, --help

Displays help documentation.

Actions

Create

Create a StackScript.
-l, --label

The label (name) for the StackScript.

-d, --distribution

Distribution name or DistributionID to deploy.

-c, --codefile

The script file name (including the path) containing the source code.

-p, --ispublic

Optional. Whether this StackScript is published in the Library, for everyone to use. Options are yes, no, true, and false. Default is false.

-D, --description

Optional. Notes describing details about the StackScript.

-r, --revnote

Optional. Note for describing the version.

Update

Update a StackScript.
-l, --label

The label (name) for the StackScript.

-n, --new-label

Optional. Renames the StackScript.

-d, --distribution

Optional. Distribution name or DistributionID to deploy.

-c, --codefile

Optional. The script file name (including the path) containing the source code.

-p, --ispublic

Optional. Whether this StackScript is published in the Library, for everyone to use. Options are yes, no, true, and false. Default is false.

-D, --description

Optional. Notes describing details about the StackScript.

-r, --revnote

Optional. Note for describing the version.

Delete

Delete a StackScript
-l, --label

The StackScript to delete.

List

List information about one or more StackScripts.
-l, --label

Optional. A specific StackScript to list.

Show

Display detailed information about one or more StackScripts.
-l, --label

Required. A specific StackScript to show.

Source

Display the source code for a StackScript.
-l, --label

Required. A specific StackScript to show.

Copyright/License

Copyright 2015 Linode, LLC.  Linode CLI is made available under the terms of the Perl Artistic License, or GPLv2 at the recipients discretion.

Perl Artistic License

Read it at <http://dev.perl.org/licenses/artistic.html>.

GNU General Public License (GPL) Version 2

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/

See the full license at <http://www.gnu.org/licenses/>.

Info

2015-01-16 perl v5.26.0 User Contributed Perl Documentation