README
¶

FTL

Documentation
Getting started
Install ftl, for example on macos:
brew tap block/ftl && brew install ftl
Create a sample project (Go)
mkdir myproject
cd myproject
ftl init myproject .
ftl new go alice
Build and deploy the module
Start FTL in one terminal:
ftl dev --wait-for=alice .
Then in a second terminal run the following:
ftl call alice.echo '{name: "Bob"}'
Project Resources
Resource | Description |
---|---|
CODEOWNERS | Outlines the project lead(s) |
CODE_OF_CONDUCT.md | Expected behavior for project contributors, promoting a welcoming environment |
CONTRIBUTING.md | Developer guide to build, test, run, access CI, chat, discuss, file issues |
GOVERNANCE.md | Project governance |
LICENSE | Apache License, Version 2.0 |
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var FormattedVersion = fmt.Sprintf("%s (%s)", Version, Timestamp.Format("2006-01-02"))
FormattedVersion includes the version and timestamp.
Timestamp parsed from timestamp (set by linker).
View Source
var Version = "dev"
Version of FTL binary (set by linker).
Functions ¶
func BaseVersion ¶ added in v0.423.1
BaseVersion returns the version without any SHA suffix. For example, "0.423.0-5-g43798ff01" becomes "0.423.0"
func IsVersionAtLeastMin ¶
IsVersionAtLeastMin returns true if any of the following are true:
- minVersion is not defined (i.e. is emptystring)
- v or minVersion is not a release version
- v > minVersion when both v and minVersion are release versions
Types ¶
This section is empty.
Directories
¶
Path | Synopsis |
---|---|
backend
|
|
controller/scheduledtask
Package scheduledtask implements a task scheduler.
|
Package scheduledtask implements a task scheduler. |
libdal
Package libdal provides common types and functions for domain-specific DALs.
|
Package libdal provides common types and functions for domain-specific DALs. |
runner
Package runner contains a server that implements the RunnerService and proxies VerbService requests to user code.
|
Package runner contains a server that implements the RunnerService and proxies VerbService requests to user code. |
cmd
|
|
ftl-gen-lsp
This program generates hover items for the FTL LSP server.
|
This program generates hover items for the FTL LSP server. |
common
|
|
encoding
Package encoding defines the internal encoding that FTL uses to encode and decode messages.
|
Package encoding defines the internal encoding that FTL uses to encode and decode messages. |
reflect
Package reflect implements the proposal https://go.dev/issue/51520.
|
Package reflect implements the proposal https://go.dev/issue/51520. |
strcase
Package strcase provides programming case conversion functions for strings.
|
Package strcase provides programming case conversion functions for strings. |
frontend
|
|
compile
Package compile compiles FTL Go module source into a deployable executable.
|
Package compile compiles FTL Go module source into a deployable executable. |
ftl/ftltest
Package ftltest contains test utilities for the ftl package.
|
Package ftltest contains test utilities for the ftl package. |
jvm-runtime
|
|
Click to show internal directories.
Click to hide internal directories.