github.com/grahambrereton-form3/tilt@v0.10.18/README.md (about)

     1  # Tilt
     2  
     3  <img src="assets/logo-wordmark.png" width="250">
     4  
     5  [![Build Status](https://circleci.com/gh/windmilleng/tilt/tree/master.svg?style=shield)](https://circleci.com/gh/windmilleng/tilt)
     6  [![GoDoc](https://godoc.org/github.com/windmilleng/tilt?status.svg)](https://godoc.org/github.com/windmilleng/tilt)
     7  
     8  Local Kubernetes development with no stress.
     9  
    10  [Tilt](https://tilt.dev) helps you develop your microservices locally.
    11  Run `tilt up` to start working on your services in a complete dev environment
    12  configured for your team.
    13  
    14  Tilt watches your files for edits, automatically builds your container images,
    15  and applies any changes to bring your environment
    16  up-to-date in real-time. Think `docker build && kubectl apply` or `docker-compose up`.
    17  
    18  ## Watch: Tilt in Two Minutes
    19  
    20  [![screencast](assets/demothumb.png)](https://www.youtube.com/watch?v=oSljj0zHd7U)
    21  
    22  ## Install Tilt
    23  
    24  If you don't know where to start, start here:
    25  
    26  [Complete Tilt User Guide](https://docs.tilt.dev/)
    27  
    28  Download the Tilt binary on
    29  [the github releases page](https://github.com/windmilleng/tilt/releases).
    30  
    31  Tilt expects that you already have Docker and `kubectl` installed. Alternately, you can
    32  skip Kubernetes altogether and run Tilt with your pre-existing `docker-compose.yml`.
    33  Read the more detailed [Installation Guide](https://docs.tilt.dev/install.html)
    34  to help you `tilt up` quickly.
    35  
    36  ## Configure Your Workflow to Share With Your Team
    37  
    38  Configure Tilt with a `Tiltfile`, written in a small subset of Python called
    39  [Starlark](https://github.com/bazelbuild/starlark#tour).
    40  
    41  To get started, check out the [tutorial](https://docs.tilt.dev/tutorial.html) or dive into the
    42  [API reference](https://docs.tilt.dev/api.html).
    43  
    44  ## Community
    45  
    46  Questions? Comments? Just want to say hi?
    47  
    48  Find us on the Kubernetes slack. Get an invite at [slack.k8s.io](http://slack.k8s.io) and find
    49  us in [the **#tilt** channel](https://kubernetes.slack.com/messages/CESBL84MV/).
    50  
    51  We tweet [@tilt_dev](https://twitter.com/tilt_dev) and
    52  blog about building Tilt at [blog.tilt.dev](https://blog.tilt.dev).
    53  
    54  We expect everyone in our community (users, contributors, followers, and employees alike) to abide by our [**Code of Conduct**](https://docs.tilt.dev/code_of_conduct.html).
    55  
    56  ## Development
    57  
    58  To make changes to Tilt, read the [developer guide](DEVELOPING.md).
    59  
    60  For bugs and feature requests, file an [issue](https://github.com/windmilleng/tilt/issues)
    61  or check out the [feature roadmap](https://github.com/orgs/windmilleng/projects/3).
    62  
    63  ## Telemetry and Privacy
    64  We're a small company trying to make Tilt awesomer. We can do this better if we understand which features people are using and which bugs people are running into. You can enable sending telemetry data to https://events.windmill.build in the UI or by running `tilt analytics opt in`. It really helps us!
    65  
    66  The data is meant to be about your use of Tilt (e.g., which Tiltfile or Web UI features do you use), not collecting data about you or your project. It's possible that some of the data we collect could include snippets of data about your project (e.g. that you have a service named `deathray-backend` or an error message that includes the string it failed to parse). We try to avoid this, but you should probably not opt-in if you're working on a classified project.
    67  
    68  We will not resell or give away this data. (Data may be sent to third parties, like Datadog,
    69  but only to help us analyze the data.)
    70  
    71  You can change your mind at any time by running `tilt analytics opt <in|out>` and restarting Tilt. Until you make a choice, Tilt will send a minimal amount of data (this helps us improve the installation/opting flow).
    72  
    73  Tilt connects to other online services for purposes like finding and downloading product updates and resources.
    74  
    75  ## License
    76  
    77  Copyright 2018 Windmill Engineering
    78  
    79  Licensed under [the Apache License, Version 2.0](LICENSE)