Command Line Interface

at

Artisan Tools CLI.

at [OPTIONS] COMMAND [ARGS]...

Options

--version

Show artisan-tools version

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

container

Tools for container images

at container [OPTIONS] COMMAND [ARGS]...

build-push

Build (and push) a container image to a container registry.

Example: ``build-push ghcr.io/user/test tag1 tag2 –platform linux/amd64

–platform linux/arm64 –option “–file=/path/to/Dockerfile”``

at container build-push [OPTIONS] REPOSITORY [TAGS]...

Options

--platform <platform>

Platform to build for. Can be used multiple times. Default is (‘linux/amd64’).

Default:

linux/amd64

--context <context>

The build context. Default is current directory.

Default:

.

--option <option>

Additional options to pass to the build command, can be used multiple times

Default:

Arguments

REPOSITORY

Required argument

TAGS

Optional argument(s)

command

Run a command with authentication to container registry.

at container command [OPTIONS] COMMAND

Arguments

COMMAND

Required argument

login

Login to container registry as specified in the configuration file.

When auth == direct, use the user and token directly. When auth == env, use the environment variables specified in user and token

at container login [OPTIONS]

logout

Log out of the container registry.

Registry and engine are read from the configuration file.

at container logout [OPTIONS]

push

Pushes a Docker image to a container registry.

Args:

source: The source image to push, can contain tags. target: The target image to push to, must not include tags. tags: List of tags to push to the target image. Tags will be parsed by

the parser extension.

Returns:

None: This method does not return anything.

Raises:

None: This method does not raise any exceptions.

at container push [OPTIONS] SOURCE TARGET TAGS...

Arguments

SOURCE

Required argument

TARGET

Required argument

TAGS

Required argument(s)

vcs

Tools for version control system

at vcs [OPTIONS] COMMAND [ARGS]...

add-tag

Add a tag to the current commit and push it to remote git repository.

Parameters

tagstr

The tag to add. The tag is parsed by the parser extension. Default is ‘v@version’, which will render as e.g. ‘v1.0.0’.

at vcs add-tag [OPTIONS] [TAG]

Arguments

TAG

Optional argument

check-branch

Check if the current Git branch is the specified branch.

at vcs check-branch [OPTIONS] EXPECTED_BRANCH

Arguments

EXPECTED_BRANCH

Required argument

check-no-tag

Check if a specific tag exists in the remote Git repository.

at vcs check-no-tag [OPTIONS] TAG

Arguments

TAG

Required argument

version

Tools for managing version information.

at version [OPTIONS] COMMAND [ARGS]...

bump

Bump the version in the specified file.

at version bump [OPTIONS] PART

Arguments

PART

Required argument

get

Print the current version to stdout.

at version get [OPTIONS]

verify

Verify if the current version is valid.

param check_tag:

Check that current versions isn’t already a tag

at version verify [OPTIONS]

Options

--check-tag, --no-check-tag

Check that current versions isn’t already a tag

Default:

False