cli

command
v3.0.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2026 License: BSD-2-Clause Imports: 3 Imported by: 0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package app resolves what an instance command acts on: the application a target names, the directory it lives in, the pair of instances description and cluster config it runs from, and the instances the target selects.
Package app resolves what an instance command acts on: the application a target names, the directory it lives in, the pair of instances description and cluster config it runs from, and the instances the target selects.
chain
Package chain builds recovery chains from backup manifests.
Package chain builds recovery chains from backup manifests.
gc
Package gc deletes backup chains by retention rules and cleans up dangling archives.
Package gc deletes backup chains by retention rules and cleans up dangling archives.
verify
Package verify health-checks a backup storage: manifest chain integrity, archive presence and checksums, dangling archives.
Package verify health-checks a backup storage: manifest chain integrity, archive presence and checksums, dangling archives.
cmd
cmd
clidoc
Package clidoc renders the command reference of tt as Markdown pages from the command tree tt runs: a page for every top-level command, with its subcommands under it, a page for every help topic, and an index of them.
Package clidoc renders the command reference of tt as Markdown pages from the command tree tt runs: a page for every top-level command, with its subcommands under it, a page for every help topic, and an index of them.
helpgolden
Package helpgolden renders what tt prints for help and completion, for tests that pin it against a golden file: the --help of every command, the bash completion script and the completions of the first word.
Package helpgolden renders what tt prints for help and completion, for tests that pin it against a golden file: the --help of every command, the bash completion script and the completions of the first word.
Package configure fills the process context of tt for the command line: the project the working directory is in, the tarantool and tcm executables the commands run, and the config of tt daemon.
Package configure fills the process context of tt for the command line: the project the working directory is in, the tarantool and tcm executables the commands run, and the config of tt daemon.
internal/steps
Package steps provides a set of handlers for create command chain of responsibility.
Package steps provides a set of handlers for create command chain of responsibility.
api
test_process command
Package exitcode turns the error a tt command ends with into the process exit status, and reports that error to the user once.
Package exitcode turns the error a tt command ends with into the process exit status, and reports that error to the user once.
Package logging sets up the process logger of the tt core.
Package logging sets up the process logger of the tt core.
Package manifest is the data layer for tt packages: Go types for the manifest (app.manifest.toml) and the lock (app.manifest.lock), TOML reading and writing, structural validation and format-version handling.
Package manifest is the data layer for tt packages: Go types for the manifest (app.manifest.toml) and the lock (app.manifest.lock), TOML reading and writing, structural validation and format-version handling.
build
Package build is the orchestration layer of the tt manifest pipeline: it runs the full build cycle of a package (tt package build) and its fetch-only slice (tt package fetch).
Package build is the orchestration layer of the tt manifest pipeline: it runs the full build cycle of a package (tt package build) and its fetch-only slice (tt package fetch).
build/backend
Package backend runs a single component build backend and places the resulting artifacts in TT_OUTPUT_DIR.
Package backend runs a single component build backend and places the resulting artifacts in TT_OUTPUT_DIR.
deps
Package deps implements the commands that work on what a package depends on.
Package deps implements the commands that work on what a package depends on.
distbuild
Package distbuild builds a distribution of tt: a tt binary made of the tt core and the tt modules tt.manifest.toml lists.
Package distbuild builds a distribution of tt: a tt binary made of the tt core and the tt modules tt.manifest.toml lists.
install
Package install implements tt package install: it unpacks a .tt package archive into a chosen scope and brings the tree to a runnable state.
Package install implements tt package install: it unpacks a .tt package archive into a chosen scope and brings the tree to a runnable state.
inventory
Package inventory implements the two commands that work over what an install left on disk: tt package list, which reports the packages present in a scope, and tt package uninstall, which removes a guest package and the shared dependencies it was the last to hold, or, in the user and system scopes, an application with all its installed versions.
Package inventory implements the two commands that work over what an install left on disk: tt package list, which reports the packages present in a scope, and tt package uninstall, which removes a guest package and the shared dependencies it was the last to hold, or, in the user and system scopes, an application with all its installed versions.
native
Package native tells native files - ELF and Mach-O binaries - by their content, and reports what they need to run: the platforms they run on and, for an ELF program, the loader and the shared libraries it asks for.
Package native tells native files - ELF and Mach-O binaries - by their content, and reports what they need to run: the platforms they run on and, for an ELF program, the loader and the shared libraries it asks for.
pack
Package pack implements tt package pack: it runs the manifest build and then assembles its result into a reproducible .tt archive (tar+zstd).
Package pack implements tt package pack: it runs the manifest build and then assembles its result into a reproducible .tt archive (tar+zstd).
registry
Package registry implements the commands that address rock servers directly: reporting the effective server list, searching it, and downloading rock files into a directory.
Package registry implements the commands that address rock servers directly: reporting the effective server list, searching it, and downloading rock files into a directory.
resolve
Package resolve is the dependency-resolution engine for tt packages: it turns the declared constraints of a manifest into a pinned closure and builds the lock (app.manifest.lock) - declared, resolved, locked.
Package resolve is the dependency-resolution engine for tt packages: it turns the declared constraints of a manifest into a pinned closure and builds the lock (app.manifest.lock) - declared, resolved, locked.
rocks
Package rocks is the single point in tt that knows about the go-luarocks engine (github.com/tarantool/go-luarocks).
Package rocks is the single point in tt that knows about the go-luarocks engine (github.com/tarantool/go-luarocks).
run
Package run answers the two questions every workflow shortcut over a tt package has to answer before it can hand control to Tarantool: which interpreter this project runs under, and how the tt process gets out of the way once it is chosen.
Package run answers the two questions every workflow shortcut over a tt package has to answer before it can hand control to Tarantool: which interpreter this project runs under, and how the tt process gets out of the way once it is chosen.
scaffold
Package scaffold writes the skeleton app.manifest.toml that tt new creates.
Package scaffold writes the skeleton app.manifest.toml that tt new creates.
state
Package state owns tt's on-disk install state: where each scope puts what tt package install unpacks, and the metadata list and uninstall read back.
Package state owns tt's on-disk install state: where each scope puts what tt package install unpacks, and the metadata list and uninstall read back.
version
Package version derives a package version from a git tree and an optional VERSION file, and renders the version.lua descriptor that the build drops into a package.
Package version derives a package version from a git tree and an optional VERSION file, and renders the version.lua descriptor that the build drops into a package.
Package printing is the tt core's side of github.com/tarantool/tt/sdk/output: it makes the Printer a command writes its result through, with the formats the SDK does not encode itself - YAML - and the terminal check that decides styling.
Package printing is the tt core's side of github.com/tarantool/tt/sdk/output: it makes the Printer a command writes its result through, with the formats the SDK does not encode itself - YAML - and the terminal check that decides styling.
cmd
Package restore prepares a node's work directory from backup archives so Tarantool can start on a chosen recovery point.
Package restore prepares a node's work directory from backup archives so Tarantool can start on a chosen recovery point.
Package tarantool chooses the tarantool executable an application runs on.
Package tarantool chooses the tarantool executable an application runs on.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL