ftl

package module

v0.510.3 Latest Latest Go to latest Published: Jun 4, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/block/ftl

Links

Open Source Insights

README ¶

FTL

Documentation

https://block.github.io/ftl/

Getting started

Install ftl, for example on macos:

brew tap block/ftl && brew install ftl

Create a sample project (Go)

ftl init myproject
cd myproject
ftl module new go alice

Build and deploy the module

Start FTL:

ftl dev --wait-for=alice

Now let's call a verb:

ftl call alice.hello '{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 ¶

Variables
func BaseVersion(v string) string
func IsRelease(v string) bool
func IsVersionAtLeastMin(v string, minVersion string) bool

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.

View Source

var Timestamp = time.Unix(must.Get(strconv.ParseInt(timestamp, 0, 64)), 0)

Timestamp parsed from "timestamp".

View Source

var Version = "dev"

Version of FTL binary (set by linker).

Functions ¶

func BaseVersion ¶ added in v0.423.1

func BaseVersion(v string) string

BaseVersion returns the version without any SHA suffix. For example, "0.423.0-5-g43798ff01" becomes "0.423.0"

func IsRelease ¶

func IsRelease(v string) bool

IsRelease returns true if the version is a release version.

func IsVersionAtLeastMin ¶

func IsVersionAtLeastMin(v string, minVersion string) bool

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.

Source Files ¶

View all Source files

version.go

Directories ¶

Path	Synopsis
backend
admin
console
controller/leases
controller/observability
controller/scheduledtask Package scheduledtask implements a task scheduler.	Package scheduledtask implements a task scheduler.
cron
cron/observability
goose
ingress
lease
protos/xyz/block/ftl/admin/v1
protos/xyz/block/ftl/admin/v1/adminpbconnect
protos/xyz/block/ftl/buildengine/v1
protos/xyz/block/ftl/buildengine/v1/buildenginepbconnect
protos/xyz/block/ftl/console/v1
protos/xyz/block/ftl/console/v1/consolepbconnect
protos/xyz/block/ftl/cron/v1
protos/xyz/block/ftl/hotreload/v1
protos/xyz/block/ftl/hotreload/v1/hotreloadpbconnect
protos/xyz/block/ftl/language/v1
protos/xyz/block/ftl/language/v1/languagepbconnect
protos/xyz/block/ftl/lease/v1
protos/xyz/block/ftl/lease/v1/leasepbconnect
protos/xyz/block/ftl/provisioner/v1
protos/xyz/block/ftl/provisioner/v1/provisionerpbconnect
protos/xyz/block/ftl/pubsub/v1
protos/xyz/block/ftl/pubsub/v1/pubsubpbconnect
protos/xyz/block/ftl/query/v1
protos/xyz/block/ftl/query/v1/querypbconnect
protos/xyz/block/ftl/raft/v1
protos/xyz/block/ftl/raft/v1/raftpbconnect
protos/xyz/block/ftl/test/v1
protos/xyz/block/ftl/test/v1/testpbconnect
protos/xyz/block/ftl/timeline/v1
protos/xyz/block/ftl/timeline/v1/timelinepbconnect
protos/xyz/block/ftl/v1
protos/xyz/block/ftl/v1/ftlv1connect
provisioner
provisioner/scaling
provisioner/scaling/k8sscaling
provisioner/scaling/localscaling
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.
runner/observability
runner/proxy
runner/pubsub
runner/pubsub/observability
runner/query
schemamirror
schemaservice
timeline
cmd
ftl command
ftl-admin command
ftl-console command
ftl-cron command
ftl-gen-lsp command This program generates hover items for the FTL LSP server.	This program generates hover items for the FTL LSP server.
ftl-http-ingress command
ftl-lease command
ftl-provisioner command
ftl-provisioner-cloudformation command
ftl-provisioner-sandbox command
ftl-proxy-pg command
ftl-runner command
ftl-schema command
ftl-schema-mirror command
ftl-timeline command
go2proto command
raft-tester command
common
builderrors
cron
duration
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.
errors
key
log
plugin
protos/xyz/block/ftl/schema/v1
provisioner
reflect Package reflect implements the proposal https://go.dev/issue/51520.	Package reflect implements the proposal https://go.dev/issue/51520.
reflection
schema
schema/builder
schema/change
sha256
slices
strcase Package strcase provides programming case conversion functions for strings.	Package strcase provides programming case conversion functions for strings.
frontend
console
go-runtime
cmd/ftl-language-go command
compile Package compile compiles FTL Go module source into a deployable executable.	Package compile compiles FTL Go module source into a deployable executable.
ftl
ftl/ftltest Package ftltest contains test utilities for the ftl package.	Package ftltest contains test utilities for the ftl package.
goplugin
internal
schema
schema/call
schema/common
schema/config
schema/data
schema/enum
schema/finalize
schema/initialize
schema/metadata
schema/secret
schema/topic
schema/transitive
schema/typealias
schema/typeenum
schema/typeenumvariant
schema/valueenumvariant
schema/verb
server
server/query
server/rpccontext
internal
authn
bind
buildengine Package buildengine provides a framework for building FTL modules.	Package buildengine provides a framework for building FTL modules.
buildengine/languageplugin
channels
clirpc clirpc is a package that provides a way to run RPC commands as CLI commands	clirpc is a package that provides a way to run RPC commands as CLI commands
concurrency
config Package config is the FTL configuration and secret management API.	Package config is the FTL configuration and secret management API.
config/kubeconfig
container
cors
deploymentcontext
dev
devstate
download
dsn
editor
egress
eventstream
exec
flock
git
goast Package goast provides a useful visitor for the Go AST.	Package goast provides a useful visitor for the Go AST.
http
integration
iterops
kube
local
localdebug
lsp Code generated by 'just lsp-generate'.	Code generated by 'just lsp-generate'.
maps
mcp
model
moduleconfig
mutex
observability
oci
pgproxy
prodinit Package prodinit" initializes the runtime environment for production.	Package prodinit" initializes the runtime environment for production.
profiles Package profiles manages the persistent profile configuration of the FTL CLI.	Package profiles manages the persistent profile configuration of the FTL CLI.
projectconfig
projectinit
provisioner
provisioner/executor
provisioner/state
raft
realm
retry
routing
rpc
rpc/headers
schema/schemaeventsource
sql
statemachine
terminal
test
testutils
testutils/modulecontext
timelineclient
unstoppable
watch
jvm-runtime
cmd/ftl-language-java command
cmd/ftl-language-kotlin command
java
kotlin
plugin/common
plugin/java
plugin/kotlin

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL