You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Ayke van Laethem ef4f46f1d1 all: version 0.33.0 3 months ago
.circleci ci: use Go 1.23 3 months ago
.github/workflows ci: update apt repo for sizediff toolchain 3 months ago
bin all: add stub pieces for GoLand support 6 years ago
builder ci: use Go 1.23 3 months ago
cgo libclang: do not make error locations relative 4 months ago
compileopts os/user: use stdlib version of this package 3 months ago
compiler compiler: add support for Go 1.23 range-over-func 3 months ago
diagnostics GNUmakefile: add spellfix target, use it. (#4387) 3 months ago
docs bulid: Rename Makefile to GNUmakefile 1 year ago
goenv all: version 0.33.0 3 months ago
hooks ci: don't add --recursive when updating submodules 8 months ago
internal GNUmakefile: add spellfix target, use it. (#4387) 3 months ago
interp make spell: add a few missing misspellings, fix format of .csv file, also fix *.md 3 months ago
lib unix: print a message when a fatal signal happens 3 months ago
loader internal/abi: implement initial version of this package 3 months ago
src ci: use Go 1.23 3 months ago
stacksize Run Nick G's spellchecker github.com/client9/misspell, carefuly fix what it found (#4235) 7 months ago
targets targets: remove import-memory flag from wasm-unknown target to fix #4319 3 months ago
testdata ci: use Go 1.23 3 months ago
tests reflect: use int in StringHeader and SliceHeader on non-AVR platforms (#4156) 6 months ago
tools wasi preview 2 support (#4027) 5 months ago
transform misspell.csv: add another misspelling. Fix by hand, since spellfix is too timid to fix in non-whitespace context? 3 months ago
.dockerignore docker: ignore changes to CI itself to avoid breaking cache on images 2 years ago
.gitignore Allows compilation of code using debug.BuildInfo and show correct tinygo version (#4343) 4 months ago
.gitmodules all: simplify wasm-tools-go dependency 4 months ago
BUILDING.md GNUmakefile: add "help" target (#4390) 3 months ago
CHANGELOG.md all: version 0.33.0 3 months ago
CODE-OF-CONDUCT.md docs: add official code of conduct using 'Contributor Covenant' 5 years ago
CONTRIBUTING.md docs: update CONTRIBUTING links to point to web site. Also replace Azure build badge with Windows build on GH Actions. 3 years ago
CONTRIBUTORS update my name in the contributors list 4 years ago
Dockerfile ci: use Go 1.23 3 months ago
GNUmakefile ci: use Go 1.23 3 months ago
LICENSE docs: update LICENSE year 2 years ago
README.md all: replace target=wasi with target=wasip1 8 months ago
colorwriter.go all: implement gdb sub-command for easy debugging 6 years ago
corpus_test.go all: change references of 'wasi' to 'wasip1'; test hygiene 8 months ago
diff.go main_test: Diff expected and actual results when tests fail (#4288) 5 months ago
errors_test.go builder: interpret linker error messages 3 months ago
flake.lock nix: upgrade to NixOS 23.11 11 months ago
flake.nix LLVM 18 support 6 months ago
go.mod GNUmakefile: add spellfix target, use it. (#4387) 3 months ago
go.sum GNUmakefile: add spellfix target, use it. (#4387) 3 months ago
main.go compiler: fixup Sprintf uses 3 months ago
main_test.go ci: use Go 1.23 3 months ago
misspell.csv make spellfix: fix top level files, too. 3 months ago
monitor.go main: show runtime panic addresses for `tinygo run` 4 months ago
monitor_test.go main: print source location when a panic happens in -monitor 2 years ago
revive.toml Lint: lint and fix src/{os,reflect} (#4228) 7 months ago
util_unix.go build: drop deprecated build tags 2 years ago
util_windows.go gdb: support daemonization on windows 4 years ago

README.md

TinyGo - Go compiler for small places

Linux macOS Windows Docker Nix CircleCI

TinyGo is a Go compiler intended for use in small places such as microcontrollers, WebAssembly (wasm/wasi), and command-line tools.

It reuses libraries used by the Go language tools alongside LLVM to provide an alternative way to compile programs written in the Go programming language.

Embedded

Here is an example program that blinks the built-in LED when run directly on any supported board with onboard LED:

package main

import (
    "machine"
    "time"
)

func main() {
    led := machine.LED
    led.Configure(machine.PinConfig{Mode: machine.PinOutput})
    for {
        led.Low()
        time.Sleep(time.Millisecond * 1000)

        led.High()
        time.Sleep(time.Millisecond * 1000)
    }
}

The above program can be compiled and run without modification on an Arduino Uno, an Adafruit ItsyBitsy M0, or any of the supported boards that have a built-in LED, just by setting the correct TinyGo compiler target. For example, this compiles and flashes an Arduino Uno:

tinygo flash -target arduino examples/blinky1

WebAssembly

TinyGo is very useful for compiling programs both for use in browsers (WASM) as well as for use on servers and other edge devices (WASI).

TinyGo programs can run in Fastly Compute, Fermyon Spin, wazero and many other WebAssembly runtimes.

Here is a small TinyGo program for use by a WASI host application:

package main

//go:wasm-module yourmodulename
//export add
func add(x, y uint32) uint32 {
	return x + y
}

// main is required for the `wasip1` target, even if it isn't used.
func main() {}

This compiles the above TinyGo program for use on any WASI runtime:

tinygo build -o main.wasm -target=wasip1 main.go

Installation

See the getting started instructions for information on how to install TinyGo, as well as how to run the TinyGo compiler using our Docker container.

Supported targets

Embedded

You can compile TinyGo programs for over 94 different microcontroller boards.

For more information, please see https://tinygo.org/docs/reference/microcontrollers/

WebAssembly

TinyGo programs can be compiled for both WASM and WASI targets.

For more information, see https://tinygo.org/docs/guides/webassembly/

Operating Systems

You can also compile programs for Linux, macOS, and Windows targets.

For more information:

Currently supported features:

For a description of currently supported Go language features, please see https://tinygo.org/lang-support/.

Documentation

Documentation is located on our web site at https://tinygo.org/.

You can find the web site code at https://github.com/tinygo-org/tinygo-site.

Getting help

If you're looking for a more interactive way to discuss TinyGo usage or development, we have a #TinyGo channel on the Gophers Slack.

If you need an invitation for the Gophers Slack, you can generate one here which should arrive fairly quickly (under 1 min): https://invite.slack.golangbridge.org

Contributing

Your contributions are welcome!

Please take a look at our Contributing page on our web site for details.

Project Scope

Goals:

  • Have very small binary sizes. Don't pay for what you don't use.
  • Support for most common microcontroller boards.
  • Be usable on the web using WebAssembly.
  • Good CGo support, with no more overhead than a regular function call.
  • Support most standard library packages and compile most Go code without modification.

Non-goals:

  • Be efficient while using zillions of goroutines. However, good goroutine support is certainly a goal.
  • Be as fast as gc. However, LLVM will probably be better at optimizing certain things so TinyGo might actually turn out to be faster for number crunching.
  • Be able to compile every Go program out there.

Why this project exists

We never expected Go to be an embedded language and so its got serious problems...

-- Rob Pike, GopherCon 2014 Opening Keynote

TinyGo is a project to bring Go to microcontrollers and small systems with a single processor core. It is similar to emgo but a major difference is that we want to keep the Go memory model (which implies garbage collection of some sort). Another difference is that TinyGo uses LLVM internally instead of emitting C, which hopefully leads to smaller and more efficient code and certainly leads to more flexibility.

The original reasoning was: if Python can run on microcontrollers, then certainly Go should be able to run on even lower level micros.

License

This project is licensed under the BSD 3-clause license, just like the Go project itself.

Some code has been copied from the LLVM project and is therefore licensed under a variant of the Apache 2.0 license. This has been clearly indicated in the header of these files.

Some code has been copied and/or ported from Paul Stoffregen's Teensy libraries and is therefore licensed under PJRC's license. This has been clearly indicated in the header of these files.