ficsit-cli

command module
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Dec 29, 2023 License: GPL-3.0 Imports: 1 Imported by: 0

README

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

amd64 386 arm64 armv7 ppc64le
Windows amd64 386 arm64 armv7 N/A
Arch yay -S ficsit-cli-bin
Debian amd64 386 arm64 armv7 ppc64le
Fedora amd64 386 arm64 armv7 ppc64le
Alpine amd64 386 arm64 armv7 ppc64le
Linux amd64 386 arm64 armv7 ppc64le
macOS darwin_all N/A

Usage

Interactive CLI

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

Command Line

Run ficsit help to see a list of available commands.

Troubleshooting

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

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

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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