otty / apps

All apps/Forc

Forc

forc

Forc stands for Fuel Orchestrator, providing tools and commands for developers working with the Fuel ecosystem.

Runs as forc|macOS, Linux, Windows|docs.fuel.network

Open form in Otty otty.toml

Sync rules

What travels, what stays, what never leaves

Forc in your home directory Every rule on this page, by file

· git/ Exclude

· credentials.toml Never synced

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/forc/otty.tomlThe file this page is generated from

id = "forc"

name = "Forc"

homepage = "https://docs.fuel.network/docs/forc/"

description = "Forc stands for Fuel Orchestrator, providing tools and commands for developers working with the Fuel ecosystem."

# The Fuel mark forc is named for, from the Fuel documentation site.

icon = "https://docs.fuel.network/icons/fuel-logo-512.png"

executables = ["forc"]

[dotfiles]

# Forc is configured per project (Forc.toml in the package directory). The only

# user-level file it writes is the registry token.

paths = []

# Where forc checks out git dependencies. `git_checkouts_directory()` in

# forc-util/src/lib.rs is `user_forc_directory().join("git").join("checkouts")`

# — someone else's source, re-fetchable, never something to carry along.

# https://github.com/FuelLabs/sway/blob/master/forc-util/src/lib.rs

exclude = ["~/.forc/git/"]

# The whole file is the publish token. forc-publish's README:

# Requires either the `--token` argument to be passed, the environment

# variable `FORC_PUB_TOKEN`, or a `~/.forc/credentials.toml` file like this:

# [registry]

# token = "YOUR_TOKEN"

# and src/credentials.rs backs it up: `CREDENTIALS_FILE = "credentials.toml"`

# joined onto `user_forc_directory()`, which forc-util documents as

# "the user's `.forc` directory, `$HOME/.forc` by default". `dirs::home_dir()`

# is the user profile on Windows, so `~/` is the only spelling.

# https://github.com/FuelLabs/sway/blob/master/forc-plugins/forc-publish/README.md

# https://github.com/FuelLabs/sway/blob/master/forc-plugins/forc-publish/src/credentials.rs

secret = ["~/.forc/credentials.toml"]

[commands]

format = 1

label = "Forc project"

description = "Create, build and test Sway projects with Forc. Only flags present in the Fig completion spec are offered."

quality = "ai-draft"

base = "fig:forc"

parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/forc.ts"

license = "MIT"

[[commands.subcommand]]

path = ["new"]

label = "Create a project"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/forc.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "path"

label = "Project path"

type = "path"

position = 0

path = { kind = "directory", role = "output", must_exist = false }

sources = ["fig"]

[[commands.subcommand.task]]

id = "new"

label = "New project"

fields = ["path"]

required = ["path"]

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["path"]

[[commands.subcommand]]

path = ["build"]

label = "Build a project"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/forc.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "path"

label = "Project path"

type = "path"

option = ["-p"]

path = { kind = "directory", role = "input" }

sources = ["fig"]

[[commands.subcommand.field]]

id = "terse"

label = "Terse output"

type = "boolean"

option = ["-t"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "build"

label = "Build"

fields = ["path", "terse"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["path", "terse"]

[[commands.subcommand]]

path = ["test"]

label = "Run unit tests"

[[commands.subcommand.source]]

id = "fig"

kind = "completion"

url = "https://github.com/withfig/autocomplete/blob/master/src/forc.ts"

license = "MIT"

[[commands.subcommand.field]]

id = "filter"

label = "Test name filter"

type = "string"

position = 0

sources = ["fig"]

[[commands.subcommand.field]]

id = "path"

label = "Project path"

type = "path"

option = ["-p"]

path = { kind = "directory", role = "input" }

sources = ["fig"]

[[commands.subcommand.field]]

id = "terse"

label = "Terse output"

type = "boolean"

option = ["-t"]

sources = ["fig"]

[[commands.subcommand.task]]

id = "test"

label = "Run tests"

fields = ["filter", "path", "terse"]

required = []

[[commands.subcommand.group]]

id = "basic"

label = "Basic"

fields = ["filter", "path", "terse"]

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/forc. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these keeps the credential file out.