ficsit-cli-flake/docs/ficsit.md
Rob B e313efdfec
feat: compatibility info display in View Mod screen. log to ficsit-cli.log by default (#33)
* 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>
2023-12-28 04:32:56 +02:00

35 lines
1.7 KiB
Markdown

## ficsit
cli mod manager for satisfactory
### Options
```
--api-base string URL for API (default "https://api.ficsit.app")
--api-key string API key to use when sending requests
--cache-dir string The cache directory (default "/home/{{Username}}/.cache/ficsit")
--concurrent-downloads int Maximum number of concurrent downloads (default 5)
--dry-run Dry-run. Do not save any changes
--graphql-api string Path for GraphQL API (default "/v2/query")
-h, --help help for ficsit
--installations-file string The installations file (default "installations.json")
--local-dir string The local directory (default "/home/{{Username}}/.local/share/ficsit")
--log string The log level to output (default "info")
--log-file string File to output logs to
--offline Whether to only use local data
--pretty Whether to render pretty terminal output (default true)
--profiles-file string The profiles file (default "profiles.json")
--quiet Do not log anything to console
```
### SEE ALSO
* [ficsit apply](ficsit_apply.md) - Apply profiles to all installations
* [ficsit cli](ficsit_cli.md) - Start interactive CLI (default)
* [ficsit installation](ficsit_installation.md) - Manage installations
* [ficsit profile](ficsit_profile.md) - Manage profiles
* [ficsit search](ficsit_search.md) - Search mods
* [ficsit smr](ficsit_smr.md) - Manage mods on SMR
* [ficsit version](ficsit_version.md) - Print current version information
###### Auto generated by spf13/cobra on 7-Dec-2023