ftl

package module
v0.412.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

README


FTL CI License

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)
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.

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

Timestamp parsed from timestamp (set by linker).

View Source
var Version = "dev"

Version of FTL binary (set by linker).

Functions

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.

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
cli
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.
automaxprocs
Package automaxprocs sets GOMAXPROCS to match Linux container CPU quota.
Package automaxprocs sets GOMAXPROCS to match Linux container CPU quota.
buildengine
Package buildengine provides a framework for building FTL modules.
Package buildengine provides a framework for building FTL modules.
configuration
Package configuration is the FTL configuration and secret management API.
Package configuration is the FTL configuration and secret management API.
dev
dsn
goast
Package goast provides a useful visitor for the Go AST.
Package goast provides a useful visitor for the Go AST.
log
lsp
Code generated by 'just lsp-generate'.
Code generated by 'just lsp-generate'.
profiles/internal
Package internal manages the persistent profile configuration of the FTL CLI.
Package internal manages the persistent profile configuration of the FTL CLI.
rpc
jvm-runtime

Jump to

Keyboard shortcuts

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