github.com/tilt-dev/tilt@v0.36.0/README.md (about)

     1  # Tilt
     2  
     3  <img src="assets/logo-wordmark.png" width="250">
     4  
     5  [![Build Status](https://circleci.com/gh/tilt-dev/tilt/tree/master.svg?style=shield)](https://circleci.com/gh/tilt-dev/tilt)
     6  [![GoDoc](https://godoc.org/github.com/tilt-dev/tilt?status.svg)](https://pkg.go.dev/github.com/tilt-dev/tilt)
     7  
     8  Kubernetes for Prod, Tilt for Dev
     9  
    10  Modern apps are made of too many services. They're everywhere and in constant
    11  communication.
    12  
    13  [Tilt](https://tilt.dev) powers microservice development and makes sure they behave!
    14  Run `tilt up` to work in a complete dev environment configured for your team.
    15  
    16  Tilt automates all the steps from a code change to a new process: watching
    17  files, building container images, and bringing your environment
    18  up-to-date. Think `docker build && kubectl apply` or `docker-compose up`.
    19  
    20  ## Watch: Tilt in Two Minutes
    21  
    22  [![screencast](assets/tilt-video.png)](https://www.youtube.com/watch?v=FSMc3kQgd5Y)
    23  
    24  ## Install Tilt
    25  
    26  Installing the `tilt` binary is a one-step command.
    27  
    28  ### macOS/Linux
    29  
    30  ```bash
    31  curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash
    32  ```
    33  
    34  ### Windows
    35  
    36  ```powershell
    37  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.ps1'))
    38  ```
    39  
    40  For specific package managers (Homebrew, Scoop, Conda, asdf), see the
    41  [Installation Guide](https://docs.tilt.dev/install.html).
    42  
    43  ## Run Tilt
    44  
    45  **New to Tilt?** Our tutorial will [get you started](https://docs.tilt.dev/tutorial.html).
    46  
    47  **Configuring a Service?** We have best practice guides for 
    48  [HTML](https://docs.tilt.dev/example_static_html.html), 
    49  [NodeJS](https://docs.tilt.dev/example_nodejs.html), 
    50  [Python](https://docs.tilt.dev/example_python.html), 
    51  [Go](https://docs.tilt.dev/example_go.html),
    52  [Java](https://docs.tilt.dev/example_java.html),
    53  and [C#](https://docs.tilt.dev/example_csharp.html).
    54  
    55  **Optimizing a Tiltfile?** Search for the function you need in our 
    56  [complete API reference](https://docs.tilt.dev/api.html).
    57  
    58  ## Community & Contributions
    59  
    60  **Questions:** Join [the Kubernetes slack](http://slack.k8s.io) and
    61   find us in the [#tilt](https://kubernetes.slack.com/messages/CESBL84MV/)
    62   channel. Or [file an issue](https://github.com/tilt-dev/tilt/issues). For code snippets of Tiltfile functionality shared by the Tilt community, check out [Tilt Extensions](https://github.com/tilt-dev/tilt-extensions). 
    63  
    64  **Contribute:** Check out our [guidelines](CONTRIBUTING.md) to contribute to Tilt's source code. To extend the capabilities of Tilt via new Tiltfile functionality, read more about [Extensions](https://docs.tilt.dev/extensions.html).
    65  
    66  **Follow along:** [@tilt_dev](https://twitter.com/tilt_dev) on Twitter. For updates
    67  and announcements, follow [the blog](https://blog.tilt.dev) or subscribe to 
    68  [the newsletter](https://tilt.dev/subscribe).
    69  
    70  **Help us make Tilt even better:** Tilt sends anonymized usage data, so we can
    71  improve Tilt on every platform. Details in ["What does Tilt
    72  send?"](http://docs.tilt.dev/telemetry_faq.html).
    73  
    74  We expect everyone in our community (users, contributors, followers, and employees alike) to abide by our [**Code of Conduct**](CODE_OF_CONDUCT.md).
    75  
    76  ## Reporting security issues
    77  
    78  The maintainers take security seriously. If you discover a security issue,
    79  please bring it to their attention right away!
    80  
    81  Please **DO NOT** file a public issue, instead send your report privately to
    82  [security@docker.com](mailto:security@docker.com).
    83  
    84  Security reports are greatly appreciated and we will publicly thank you for it.
    85  We also like to send gifts—if you're into Docker schwag, make sure to let
    86  us know. We currently do not offer a paid security bounty program, but are not
    87  ruling it out in the future.
    88  
    89  ## License
    90  
    91  Copyright 2022 Docker, Inc.
    92  
    93  Licensed under [the Apache License, Version 2.0](LICENSE)