Spaces Docs

Shell

def chmod(name, mode, path, deps, type, inputs, help, working_directory, visibility, expect)

Changes the mode of a file or directory.

Args

name: string: The name of the rule.
mode: string: The source file or directory.
path: string: The path/file to change permissions for.
deps: list: The dependencies for the copy command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success|Failure

def cp(name, source, destination, options, deps, type, inputs, help, working_directory, visibility, expect)

Copy a file or directory from source to destination.

Args

name: string: The name of the rule.
source: string: The source file or directory.
destination: string: The destination file or directory.
options: list: The options for the copy command.
deps: list: The dependencies for the copy command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success | Failure

def ln(name, source, destination, options, deps, type, inputs, help, working_directory, visibility, expect)

Create a link from source to destination.

Args

name: string: The name of the rule.
source: string: The source file or directory.
destination: string: destination or target (to be created).
options: list: The options for the copy command.
deps: list: The dependencies for the copy command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success|Failure

def ls(name, path, options, deps, type, inputs, help, working_directory, visibility, expect)

Run ls (this can be handy for checking if something exists).

Args

name: string: The name of the rule.
path: string: The directory to list.
options: list: The options for the ls command.
deps: list: The dependencies for the ls command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success|Failure

def mkdir(name, path, options, deps, type, inputs, help, working_directory, visibility, expect)

Create a new directory.

Args

name: string: The name of the rule.
path: string: The source file or directory.
options: list: The options for the copy command.
deps: list: The dependencies for the copy command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success|Failure

def mv(name, source, destination, options, deps, type, inputs, help, working_directory, visibility, expect)

Rename a file or directory from source to destination.

Args

name: string: The name of the rule.
source: string: The source file or directory.
destination: string: The destination file or directory.
options: list: The options for the move command.
deps: list: The dependencies for the move command.
type: The type of the command.
inputs: The inputs for the command.
help: The help message for the command.
working_directory: The working directory for the command.
visibility: Rule visibility: Public|Private|Rules[]. See visbility.star for more info.
expect: string: Success|Failure

def shell(name, script, shell, options, expect, type, inputs, help, working_directory, visibility, deps)

Add a run rule that executes a shell script.

Args