No description
e313efdfec
* fix: log by default (ficsit-cli.log in CWD) * chore: update readme with info on code generation * chore: regenerate docs for default log file location * feat: compatibility info state and note display. wip: keybind to switch view modes not working * fix: move render code out to a function, but it still isn't quite working yet * feat: display mod reference below mod name * Fix compat toggle with * Show scroll up/down on quick help * chore: fix merge conflict * chore: run go install mvdan.cc/gofumpt@latest; gofumpt -l -w . * chore: run gci.exe write --skip-generated -s standard -s default -s 'prefix(github.com/satisfactorymodding/ficsit-cli)' -s blank -s dot . * chore: update readme linting info and run golangci-lint --version * fix: log file is defaulted to empty again * fix(#33): update render to return just string * fix(#33): renderModInfo returns only string * fix(#33): reollback func namechange * refactor(#33): remove redundant viewport refresh * refactor(#33): update is not required after setting content * refactor(#33): remove unrequired log * docs(#33): update documentation to latest generated * docs(#33): update cache reference to not contain username * docs(#33): fix local dir references too * refactor(#33): replace vague variable with more helpful * Add directions about using dev schema when generate command fails * Fix issues from earlier merge conflict --------- Co-authored-by: Jack Stupple <jack.stupple@protonmail.com> |
||
|---|---|---|
| .github | ||
| .vscode | ||
| cfg | ||
| cli | ||
| cmd | ||
| docs | ||
| ficsit | ||
| tea | ||
| utils | ||
| .envrc | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| cspell.json | ||
| docker-compose-test.yml | ||
| flake.lock | ||
| flake.nix | ||
| genqlient.yaml | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| README.md | ||
| shell.nix | ||
| tools.go | ||
ficsit-cli 
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