axetroy / s4 Goto Github PK

Connect to remote SSH server. Its format should be <username>@<address>:<port> [WITH [PASSWORD|FILE] [VALUE]]

eg CONNECT [email protected]:22

eg CONNECT [email protected]:22 WITH PASSWORD you_password

eg CONNECT [email protected]:22 WITH FILE ./path/to/private/key/file

If the password or private key file not provide. it will ask you to enter in terminal.

Set environmental variable for RUN command

eg ENV PRIVATE_KEY = 123

Defining variables. It has 3 ways to define it.

Its format is this VAR {key} = {value}

VAR PRIVATE_KEY = 123

RUN echo {{PRIVATE_KEY}}

Its format is this VAR {key} = ${envKey}:{tag}

tag can be local/remote. Used to specify to get local/remote environment variables.

CONNECT [email protected]:22

VAR GOPATH_LOCAL = $GOPATH:local

VAR GOPATH_REMOTE = $GOPATH:remote

RUN echo "remote GOPATH: {{GOPATH_REMOTE}}, local GOPATH: {{GOPATH_LOCAL}}"

Its format is this VAR {key} <= {bashCommand}.

This will execute command at remote and set stdout to a variable.

or use the format VAR {key} <= ["{command}", "{argument1}", "{argument2}"]. It will run in local.

VAR NODE_VERSION_LOCAL <= ["node", "-v"]

VAR NODE_VERSION_REMOTE <= node -v

RUN echo "remote version: {{NODE_VERSION_REMOTE}}, local version: {{NODE_VERSION_LOCAL}}"

VAR PRIVATE_KEY = 123
ENV PRIVATE_KEY = {{PRIVATE_KEY}}
RUN echo {{PRIVATE_KEY}}

Change the current working directory of the remote server

eg CD /home/axetroy

If the directory does not exist, an error will be thrown

This will affect all operations on the remote server, including upload/download/run commands, etc.

Upload local files to a remote server

eg UPLOAD start.py ./server

It required at least two parameters. The last parameter is the remote server's directory where should be uploaded.

The rest of the parameters are the local files path.

Download remote files to local

eg DOWNLOAD start.py ./server

It required at least two parameters. The last parameter is the local directory where should be downloaded.

The rest of the parameters are remote files path.

Copy file at the remote server

eg COPY data.db data.db.bak

Move file at the remote server

eg MOVE data.db data.db.bak

Delete files at the remote server, for security, Linux dangerous directories will be ignored

eg DELETE file1 file2

Run the command at the local or remote server

eg RUN python ./remote/start.py

It supports multi-line wrap

# run at remote
RUN npm version \
    && npm run build \
    && npm run test \
    && npm run publish

# run at local machine
RUN ["npm", "run", "build"]

Same as RUN, but will proceed to the next step regardless of the results