Categorygithub.com/satisfactorymodding/ficsit-cli
modulepackage
0.6.0
Repository: https://github.com/satisfactorymodding/ficsit-cli.git
Documentation: pkg.go.dev

# README

ficsit-cli screenshot

ficsit-cli push GitHub go.mod Go version GitHub tag (latest by date) GitHub license GitHub all releases

A CLI tool for managing mods for the game Satisfactory.


Installation

amd64386arm64armv7ppc64le
Windowsamd64386arm64N/AN/A
Archyay -S ficsit-cli-bin
Debianamd64386arm64armv7ppc64le
Fedoraamd64386arm64armv7ppc64le
Alpineamd64386arm64armv7ppc64le
Linuxamd64386arm64armv7ppc64le
macOSdarwin_allN/A

Usage

Interactive CLI

To launch the interactive CLI, run the executable without any arguments.

All screens display control hints at the bottom.

Command Line

Run ficsit help to see a list of available commands and flags.

Managing Installations

Unlike Satisfactory Mod Manager, ficsit-cli does not automatically detect installations.

First, locate your game install path. Check the Modding FAQ to learn how to find it given your specific install situation.

To add installations in the interactive CLI, use Installations > new installation.

To add installations from the command line, use ficsit-cli installation add yourPathHere.

Troubleshooting

  • Profile and installation records are located in %APPDATA%\ficsit\
  • Downloads are cached in %LOCALAPPDATA%\ficsit\downloadCache\

Get help on the modding Discord.

Development

Dependencies

  • Go 1.21
  • IDE of Choice. Goland or VSCode suggested.

Code Generation

If you update any of the GraphQL queries, run this to update generated code:

(echo "y") | npx graphqurl https://api.ficsit.app/v2/query --introspect -H 'content-type: application/json' > schema.graphql
go generate -tags tools -x ./...

If this command fails due to a mismatched schema, you may need to use the url https://api.ficsit.dev/v2/query instead.

Building

go build

Will produce ficsit-cli.exe in the repo root directory.

Linting

Install golangci-lint via the directions here, but make sure to install the version specified in .github/workflows/push.yaml instead of whatever it suggests.

Then, to run it, use:

golangci-lint run --fix

Updating generated docs

The files within ./docs are generated using cobra, use the following to update them.

go run tools.go

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author