Tilt

https://docs.tilt.dev/
Admin
Tilt automates the microservice development process by managing container builds, deployments, and...
Tokens:173,906
Snippets:1,465
Trust Score:9.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Clone and run the Go example

Source: https://docs.tilt.dev/example_go.html

Commands to clone the example repository, navigate to the base setup, and start Tilt. Tilt opens a web UI and terminal status box, and the server is ready when the status icon turns green and logs show 'Serving files on port 8000.'

```bash
git clone https://github.com/tilt-dev/tilt-example-go
cd tilt-example-go/0-base
tilt up

```

--------------------------------

### tilt create ext examples

Source: https://docs.tilt.dev/cli/tilt_create_ext.html

Examples of using 'tilt create ext' with different options and arguments. The first installs the 'cancel' extension from the default repo. The second installs 'my-kubefwd' with a custom path and passes '--namespaces=default' to the extension. The third installs 'cancel' from the 'dev' repo.

```bash
# Installs the extension from the extension repo 'default' under the path './cancel'.
tilt create ext cancel

# Installs the extension from the extension repo 'default' under
# and with custom argument '--namespaces=default' passed to the extension.
tilt create ext my-kubefwd --path=./kubefwd -- --namespaces=default

# Installs the extension from the extension repo 'dev' under the path './cancel'
tilt create ext cancel --repo=dev

```

--------------------------------

### Clone and run the example with tilt up

Source: https://docs.tilt.dev/example_csharp.html

Commands to clone the example repository and start Tilt, which opens the web UI and shows app status and logs.

```bash
git clone https://github.com/tilt-dev/tilt-example-csharp
cd tilt-example-csharp/0-base
tilt up
```

--------------------------------

### tilt lsp start usage examples

Source: https://docs.tilt.dev/cli/tilt_lsp_start.html

Two example invocations of the tilt lsp start command. The first launches the server in stdio mode with verbose logging enabled. The second uses the --address flag to listen on all interfaces on port 8765.

```bash
# Launch in stdio mode with extra logging
tilt lsp start --verbose

# Listen on all interfaces on port 8765
tilt lsp start --address=":8765"

```

--------------------------------

### tilt explain examples

Source: https://docs.tilt.dev/cli/tilt_explain.html

Shows example invocations: getting documentation for the cmds resource and for a specific field (cmds.spec.args).

```shell
  # Get the documentation of the resource and its fields
  tilt explain cmds
  # Get the documentation of a specific field of a resource
  tilt explain cmds.spec.args

```

--------------------------------

### Install fish completions for new sessions

Source: https://docs.tilt.dev/cli/tilt_completion_fish.html

Installs fish completions for every new session. Execute once, then start a new shell for the setup to take effect.

```shell
tilt completion fish > ~/.config/fish/completions/tilt.fish

```

--------------------------------

### Example output of tilt get uiresources

Source: https://docs.tilt.dev/resource_dependencies.html

Example output showing the resource list with columns NAME and CREATED AT. The output includes the docs-site, make-api, and (Tiltfile) resources.

```text
$ tilt get uiresources
NAME         CREATED AT
docs-site    2021-10-19T19:51:21Z
make-api     2021-10-19T19:51:21Z
(Tiltfile)   2021-10-19T19:51:21Z

```

--------------------------------

### Clone and run the example with tilt up

Source: https://docs.tilt.dev/example_java.html

Commands to clone the example repository, navigate to the base directory, and start Tilt. Tilt opens a browser showing the web UI and the terminal becomes a status box. When ready, the status icon turns green and logs display 'Tomcat initialized with port(s): 8000.'

```bash
git clone https://github.com/tilt-dev/tilt-example-java
cd tilt-example-java/0-base
tilt up

```

--------------------------------

### tilt snapshot create examples

Source: https://docs.tilt.dev/cli/tilt_snapshot_create.html

Examples of creating a snapshot file, redirecting to stdout, and viewing the snapshot.

```bash
tilt snapshot create snapshot.json
# or if no file is specified, it goes to stdout
tilt snapshot create > snapshot.json

# to view the snapshot
tilt snapshot view snapshot.json

```

--------------------------------

### tilt snapshot view examples

Source: https://docs.tilt.dev/cli/tilt_snapshot_view.html

Examples of running 'tilt ci' to save a snapshot and then viewing it, plus piping a snapshot to stdin with '-'. The first example runs 'tilt ci' with the '--output-snapshot-on-exit' flag to create a snapshot file, then views it. The second example pipes a snapshot from a URL to 'tilt snapshot view -'.

```bash
# Run tilt ci and save a snapshot
tilt ci --output-snapshot-on-exit=snapshot.json
# View that snapshot
tilt snapshot view snapshot.json

# Or pipe the snapshot to stdin and specify the snapshot as '-'
curl http://myci.com/path/to/snapshot | tilt snapshot view -

```

--------------------------------

### Scoop: Install Tilt

Source: https://docs.tilt.dev/install.html

Install Tilt on Windows using Scoop, adding the tilt-dev bucket first.

```powershell
scoop bucket add tilt-dev https://github.com/tilt-dev/scoop-bucket
scoop install tilt

```

--------------------------------

### Install Tilt on Windows

Source: https://docs.tilt.dev/index.html

One-step installation command for the Tilt binary on Windows. Uses PowerShell to download and execute the official install script.

```powershell
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.ps1'))

```

--------------------------------

### tilt create filewatch example

Source: https://docs.tilt.dev/cli/tilt_create_filewatch.html

Example that creates a FileWatch named 'fw' watching 'src' and 'web' directories, ignoring 'web/node_modules'.

```bash
tilt create fw src-and-web src web --ignore=web/node_modules

```

--------------------------------

### tilt docker build example

Source: https://docs.tilt.dev/cli/tilt_docker.html

Example of building a Docker image using 'tilt docker'. The command is 'tilt docker -- build -f path/to/Dockerfile .'.

```bash
tilt docker -- build -f path/to/Dockerfile .

```

--------------------------------

### Usage: tilt verify-install [flags]

Source: https://docs.tilt.dev/cli/tilt_verify-install.html

Shows the basic command syntax for verifying a Tilt installation. Run this command to check that Tilt is installed correctly.

```bash
tilt verify-install [flags]

```

--------------------------------

### tilt args usage examples

Source: https://docs.tilt.dev/cli/tilt_args.html

Examples of setting new args, editing the current args, and using an alternative editor with tilt args.

```bash
# Set new args
tilt args frontend_service backend_service -- --debug on

```

```bash
# Edit the current args
tilt args

```

```bash
# Use an alternative editor
EDITOR=nano tilt args

```

--------------------------------

### tilt create repo examples

Source: https://docs.tilt.dev/cli/tilt_create_repo.html

Examples of registering a repository with a git URL, a local filesystem path, and a specific git reference using the --ref flag.

```bash
tilt create repo default https://github.com/tilt-dev/tilt-extensions
tilt create repo default file:///home/user/src/tilt-extensions
tilt create repo default https://github.com/tilt-dev/tilt-extensions --ref=SHA

```

--------------------------------

### Run tilt demo

Source: https://docs.tilt.dev/tutorial/2-tilt-up.html

Starts a temporary local Kubernetes cluster in Docker, clones the Tilt Avatars sample project, launches a tilt up session, and cleans up on exit.

```bash
tilt demo

```

--------------------------------

### Example Tiltfile with k8s_yaml, docker_build, and k8s_resource

Source: https://docs.tilt.dev/tiltfile_authoring.html

A complete example Tiltfile that deploys YAML, builds two images, and sets up port forwarding. This is the final result of the tutorial, but you should not create it yet; the tutorial explores each part in the following sections.

```starlark
# Deploy: tell Tilt what YAML to deploy
k8s_yaml('app.yaml')

# Build: tell Tilt what images to build from which directories
docker_build('companyname/frontend', 'frontend')
docker_build('companyname/backend', 'backend')
# ...

# Watch: tell Tilt how to connect locally (optional)
k8s_resource('frontend', port_forwards=8080)

```

--------------------------------

### Install completions for every new session on macOS

Source: https://docs.tilt.dev/cli/tilt_completion_bash.html

Execute this command once to install the bash completion script for all new sessions on macOS. A new shell is required for the setup to take effect.

```bash
tilt completion bash > $(brew --prefix)/etc/bash_completion.d/tilt

```

--------------------------------

### Install completions for every new session on Linux

Source: https://docs.tilt.dev/cli/tilt_completion_bash.html

Execute this command once to install the bash completion script for all new sessions on Linux. A new shell is required for the setup to take effect.

```bash
tilt completion bash > /etc/bash_completion.d/tilt

```

--------------------------------

### Install tilt zsh completions on Linux

Source: https://docs.tilt.dev/cli/tilt_completion_zsh.html

Installs the tilt zsh completion script for every new session on Linux. The output is written to the first directory in fpath. A new shell is required for the setup to take effect.

```bash
tilt completion zsh > "${fpath[1]}/_tilt"

```

--------------------------------

### Options: -h, --help for verify-install

Source: https://docs.tilt.dev/cli/tilt_verify-install.html

Displays the help flag for the verify-install command. Use -h or --help to show help information for this command.

```bash
-h, --help   help for verify-install

```

--------------------------------

### Install tilt zsh completions on macOS

Source: https://docs.tilt.dev/cli/tilt_completion_zsh.html

Installs the tilt zsh completion script for every new session on macOS using Homebrew's zsh site-functions directory. A new shell is required for the setup to take effect.

```bash
tilt completion zsh > $(brew --prefix)/share/zsh/site-functions/_tilt

```

--------------------------------

### Configure HTTP GET readiness probe for local_resource

Source: https://docs.tilt.dev/local_resource.html

Configure a local_resource with an HTTP GET readiness probe for the serve_cmd. The probe checks the /health endpoint on port 8001 every 15 seconds. Tilt waits for the probe to succeed before starting dependent resources.

```python
local_resource(
   "probe-example",
   serve_cmd="./myserver --port=8001",
   readiness_probe=probe(
      period_secs=15,
      http_get=http_get_action(port=8001, path="/health")
   )
)

```

--------------------------------

### Get Tilt Session in YAML or JSON

Source: https://docs.tilt.dev/ci.html

Use these commands to get machine-readable output of the Tilt Session object in YAML or JSON format. The status reflects the current Tilt PID, the start time, and each target's state (waiting, running, or terminated).

```bash
tilt get session -o yaml
tilt get session -o json
```

--------------------------------

### Test Docker with hello-world

Source: https://docs.tilt.dev/tutorial/1-prerequisites.html

Tests the Docker installation by running the hello-world container, which downloads the image and prints a greeting message.

```bash
docker run --rm hello-world

```

--------------------------------

### tilt get filewatches - List filewatches

Source: https://docs.tilt.dev/file_changes.html

Lists all filewatches in the running Tilt environment. In this example, Tilt has two filewatches: one for reloading the Tiltfile (configs:singleton) and one for rebuilding the Docker image (image:example-html-image).

```shell
$ tilt get filewatches
NAME                       CREATED AT
configs:singleton          2021-05-04T22:00:32Z
image:example-html-image   2021-05-04T22:00:32Z

```

--------------------------------

### Basic Tiltfile with docker_build and k8s_yaml

Source: https://docs.tilt.dev/templating.html

Basic Tiltfile example showing how to build an image and deploy a Kubernetes YAML file. Tilt automatically applies the label app.kubernetes.io/managed-by: tilt, sets pullPolicy to IfPresent or Never for local clusters, and injects a fully-resolved image tag.

```tiltfile
docker_build('example-html-image', '.')
k8s_yaml('deployment.yaml')

```

--------------------------------

### tilt wait examples: wait for Tiltfile and Kubernetes deployment readiness

Source: https://docs.tilt.dev/cli/tilt_wait.html

Waits for the Tiltfile to load by checking the Ready condition on the uiresource named Tiltfile. When used with a Kubernetes resource, waits for the pod to deploy, start running, and pass all readiness probes.

```bash
  # Wait for the tiltfile to load.
  tilt wait --for=condition=Ready "uiresource/(Tiltfile)"
  
  # When used with a Kubernetes resource, waits for the pod
  # to deploy, start running, and pass all readiness probes.
  tilt wait --for=condition=Ready "uiresource/my-kubernetes-deployment"

```

--------------------------------

### Load extension with ext:// shorthand

Source: https://docs.tilt.dev/extensions.html

Loads the hello_world extension from the default extension repository using the ext:// shorthand.

```python
load('ext://hello_world', 'hi')

```

--------------------------------

### Conda Forge: Install Tilt

Source: https://docs.tilt.dev/install.html

Install Tilt via Conda Forge by adding the channel and installing the package.

```bash
conda config --add channels conda-forge
conda install tilt

```

--------------------------------

### Install custom resource operator with local_resource()

Source: https://docs.tilt.dev/custom_resource.html

Runs the install script in parallel using local_resource(). Set allow_parallel=True so the install does not block other work.

```python
local_resource(
  name='my-crd-operator',
  cmd='./install-my-crd-operator.sh',
  allow_parallel=True)

```

--------------------------------

### tilt create ext synopsis

Source: https://docs.tilt.dev/cli/tilt_create_ext.html

Shows the basic usage of the 'tilt create ext' command. It takes the extension name and optional arguments.

```bash
tilt create ext NAME [ARG...]

```

--------------------------------

### Install Tilt on macOS/Linux

Source: https://docs.tilt.dev/index.html

One-step installation command for the Tilt binary on macOS and Linux. Downloads and executes the official install script from the Tilt repository.

```bash
curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash

```

--------------------------------

### Windows: Configure Docker for Windows and install Tilt

Source: https://docs.tilt.dev/install.html

On Windows, first set Docker for Windows as the local Kubernetes cluster with kubectl, then install Tilt using the PowerShell installer.

```bash
kubectl config use-context docker-desktop

```

```powershell
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.ps1'))

```

--------------------------------

### Homebrew: Install Tilt

Source: https://docs.tilt.dev/install.html

Install Tilt on macOS or Linux using Homebrew.

```bash
brew install tilt

```

--------------------------------

### Build and run a server locally with serve_cmd

Source: https://docs.tilt.dev/local_resource.html

Use serve_cmd to run a persistent process. This example separates the build step (go build) from the run step (./myserver --port=8001).

```python
local_resource('local-server', cmd='go build ./cmd/myserver', serve_cmd='./myserver --port=8001', deps=['cmd/myserver'])
```

--------------------------------

### Install MicroK8s with snap and enable DNS and registry plugins

Source: https://docs.tilt.dev/choosing_clusters.html

Installs MicroK8s via snap and enables the DNS and registry plugins. Use this on Ubuntu or any Linux that supports Snap. The trailing backslashes chain the commands in a single shell invocation.

```bash
sudo snap install microk8s --classic && \
sudo microk8s.enable dns && \
sudo microk8s.enable registry

```

--------------------------------

### Install custom resource operator with local()

Source: https://docs.tilt.dev/custom_resource.html

Runs an arbitrary shell script to install a custom resource operator. This blocks Tiltfile startup until the install finishes and re-runs on every Tiltfile reload.

```python
local('./install-my-crd-operator.sh')

```

--------------------------------

### Install Docker on Linux

Source: https://docs.tilt.dev/tutorial/1-prerequisites.html

Convenience script to install Docker on Linux, auto-detecting the distribution.

```bash
curl -fsSL https://get.docker.com | sh

```

--------------------------------

### Clone and run tilt up

Source: https://docs.tilt.dev/tutorial/2-tilt-up.html

Clones the Tilt Avatars sample project and starts Tilt directly, for users who already have a local Kubernetes cluster.

```bash
git clone https://github.com/tilt-dev/tilt-avatars.git
cd tilt-avatars/
tilt up

```

--------------------------------

### Verify Tilt installation with tilt version

Source: https://docs.tilt.dev/install.html

Verify the Tilt installation by checking its version.

```bash
tilt version

```
Tokens:
Raw