Command line arguments lol US

COMMAND-LINE ARGUMENTS

ASF INCLUDEZ SUPPORT 4 SEVERAL COMMAND-LINE ARGUMENTS DAT CAN AFFECT TEH PROGRAM RUNTIME. DOSE CAN BE USD BY ADVANCD USERS IN ORDR 2 SPECIFY HOW PROGRAM SHUD RUN. IN COMPARISON WIF DEFAULT WAI OV ASF.json CONFIGURASHUN FILE, COMMAND-LINE ARGUMENTS R USD 4 CORE INITIALIZASHUN (E.G. --path), PLATFORM-SPECIFIC SETTINGS (E.G. --system-required) OR SENSITIV DATA (E.G. --cryptkey).

USAGE

USAGE DEPENDZ ON UR OS AN ASF FLAVR.

GENERIC:

dotnet ArchiSteamFarm.dll --argument --otherOne

WINDOWS:

.\ArchiSteamFarm.exe --argument --otherOne

LINUX/MACOS:

./ArchiSteamFarm --argument --otherOne

COMMAND-LINE ARGUMENTS R ALSO SUPPORTD IN GENERIC HELPR SCRIPTS SUCH AS ArchiSteamFarm.cmd OR ArchiSteamFarm.sh. IN ADDISHUN 2 DAT, U CAN ALSO USE ASF_ARGS ENVIRONMENT PROPERTY, LIEK STATD IN R MANAGEMENT AN DOCKR SECSHUNS.

IF UR ARGUMENT INCLUDEZ SPACEZ, DOAN FORGET 2 QUOTE IT. DOSE 2 R WRONG:

./ArchiSteamFarm --path /home/archi/My Downloads/ASF # Bad!
./ArchiSteamFarm --path=/home/archi/My Downloads/ASF # Bad!

HOWEVR, DOSE 2 R COMPLETELY FINE:

./ArchiSteamFarm --path "/home/archi/My Downloads/ASF" # OK
./ArchiSteamFarm "--path=/home/archi/My Downloads/ASF" # OK

ARGUMENTS

--cryptkey <key> OR --cryptkey=<key> - WILL START ASF WIF CUSTOM CRYPTOGRAFIC KEY OV <key> VALUE. DIS OPSHUN AFFECTS SECURITY AN WILL CAUSE ASF 2 USE UR CUSTOM PROVIDD <key> KEY INSTEAD OV DEFAULT WAN HARDCODD INTO TEH EXECUTABLE. SINCE DIS PROPERTY AFFECTS DEFAULT ENCRYPSHUN KEY (4 ENCRYPTIN PURPOSEZ) AS WELL AS SALT (4 HASHIN PURPOSEZ), KEEP IN MIND DAT EVRYTHIN ENCRYPTD/HASHD WIF DIS KEY WILL REQUIRE IT 2 BE PASD ON EACH ASF RUN.

THAR IZ NO REQUIREMENT ON <key> LENGTH OR CHARACTERS, BUT 4 SECURITY REASONS WE RECOMMEND 2 PICK LONG ENOUGH PASFRASE MADE OUT OV E.G. RANDOM 32 CHARACTERS, 4 EXAMPLE BY USIN tr -dc A-Za-z0-9 < /dev/urandom | head -c 32; echo COMMAND ON LINUX.

IZ NICE 2 MENSHUN DAT THAR R ALSO 2 OTHR WAYS 2 PROVIDE DIS DETAIL: --cryptkey-file AN --input-cryptkey.

DUE 2 TEH NACHUR OV DIS PROPERTY, IZ ALSO POSIBLE 2 SET CRYPTKEY BY DECLARIN ASF_CRYPTKEY ENVIRONMENT VARIABLE, WHICH CUD BE MOAR APPROPRIATE 4 PEEPS DAT WUD WANTS 2 AVOID SENSITIV DETAILS IN DA PROCES ARGUMENTS.

--cryptkey-file <path> OR --cryptkey-file=<path> - WILL START ASF WIF CUSTOM CRYPTOGRAFIC KEY READ FRUM <path> FILE. DIS SERVEZ TEH SAME PURPOSE AS --cryptkey <key> EXPLAIND ABOOV, ONLY TEH MECHANISM DIFFERS, AS DIS PROPERTY WILL READ <key> FRUM PROVIDD <path> INSTEAD. IF URE USIN DIS TOGETHR WIF --path, CONSIDR TEH FACT DAT RELATIV PATH WILL BE DIFFERENT DEPENDIN ON TEH ORDR OV ARGUMENTS, I.E. WHETHR U SWITCH --path BEFORE OR AFTR --cryptkey-file.

DUE 2 TEH NACHUR OV DIS PROPERTY, IZ ALSO POSIBLE 2 SET CRYPTKEY FILE BY DECLARIN ASF_CRYPTKEY_FILE ENVIRONMENT VARIABLE, WHICH CUD BE MOAR APPROPRIATE 4 PEEPS DAT WUD WANTS 2 AVOID SENSITIV DETAILS IN DA PROCES ARGUMENTS.

--ignore-unsupported-environment - WILL CAUSE ASF 2 IGNORE PROBLEMS RELATD 2 RUNNIN IN UNSUPPORTD ENVIRONMENT, WHICH NORMALLY IZ SIGNALIZD WIF AN ERROR AN FORCD EXIT. UNSUPPORTD ENVIRONMENT INCLUDEZ 4 EXAMPLE RUNNIN win-x64 OS-SPECIFIC BUILD ON linux-x64. WHILE DIS FLAG WILL ALLOW ASF 2 ATTEMPT RUNNIN IN SUCH SCENARIOS, BE ADVISD DAT WE DO NOT SUPPORT DOSE OFFICIALLY AN URE FORCIN ASF 2 DO IT ENTIRELY AT UR OWN RISK. IZ IMPORTANT 2 POINT OUT DAT ALL OV TEH UNSUPPORTD ENVIRONMENT SCENARIOS CAN BE CORRECTD. WE STRONGLY RECOMMEND 2 FIX TEH OUTSTANDIN PROBLEMS INSTEAD OV DECLARIN DIS ARGUMENT.

--input-cryptkey - WILL MAK ASF ASK BOUT TEH --cryptkey DURIN STARTUP. DIS OPSHUN MITE BE USEFUL 4 U IF INSTEAD OV PROVIDIN CRYPTKEY, WHETHR IN ENVIRONMENT VARIABLEZ OR FILE, UD PREFR 2 NOT HAS IT SAVD ANYWHERE AN INSTEAD INPUT IT MANUALLY ON EACH ASF RUN.

--minimized - WILL MAK ASF CONSOLE WINDOW MINIMIZE SHORTLY AFTR START. USEFUL MAINLY IN AUTO-START SCENARIOS, BUT CAN ALSO BE USD OUTSIDE OV DOSE. DIS OPSHUN REQUIREZ APPROPRIATE ENVIRONMENT SUPPORT - IT CUD NOT WERK PROPERLY IN ALL POSIBLE SCENARIOS.

--network-group <group> OR --network-group=<group> - WILL CAUSE ASF 2 INIT ITZ LIMITERS WIF CUSTOM NETWORK GROUP OV <group> VALUE. DIS OPSHUN AFFECTS RUNNIN ASF IN MULTIPLE INSTANCEZ BY SIGNALIZIN DAT GIVEN INSTANCE IZ DEPENDENT ONLY ON INSTANCEZ SHARIN TEH SAME NETWORK GROUP, AN INDEPENDENT OV TEH REST. TYPICALLY U WANTS 2 USE DIS PROPERTY ONLY IF URE ROUTIN ASF REQUESTS THRU CUSTOM MECHANISM (E.G. DIFFERENT IP ADDRESEZ) AN U WANTS 2 SET NETWORKIN GROUPS YOURSELF, WITHOUT RELYIN ON ASF 2 DO IT AUTOMATICALLY (WHICH CURRENTLY INCLUDEZ TAKIN INTO AKOWNT WebProxy ONLY). KEEP IN MIND DAT WHEN USIN CUSTOM NETWORK GROUP, DIS AR TEH UNIQUE IDENTIFIR WITHIN TEH LOCAL MACHINE, AN ASF WILL NOT TAEK INTO AKOWNT ANY OTHR DETAILS, SUCH AS WebProxy VALUE, ALLOWIN U 2 E.G. START 2 INSTANCEZ WIF DIFFERENT WebProxy VALUEZ WHICH R STILL DEPENDENT ON EACH OTHR.

DUE 2 TEH NACHUR OV DIS PROPERTY, IZ ALSO POSIBLE 2 SET TEH VALUE BY DECLARIN ASF_NETWORK_GROUP ENVIRONMENT VARIABLE, WHICH CUD BE MOAR APPROPRIATE 4 PEEPS DAT WUD WANTS 2 AVOID SENSITIV DETAILS IN DA PROCES ARGUMENTS.

--no-config-migrate - BY DEFAULT ASF WILL AUTOMATICALLY MIGRATE UR CONFIG FILEZ 2 LATEST SYNTAX. MIGRASHUN INCLUDEZ CONVERSHUN OV DEPRECATD PROPERTIEZ INTO LATEST ONEZ, REMOVIN PROPERTIEZ WIF DEFAULT VALUEZ (AS THEY HAS NO EFFECT), AS WELL AS CLEANIN UP TEH FILE IN GENERAL (CORRECTIN INDENTASHUN AN LIKEWIZE). DIS AR TEH ALMOST ALWAYS GUD IDEA, BUT U MITE HAS PARTICULAR SITUASHUN WER UD PREFR ASF 2 NEVR OVERWRITE TEH CONFIG FILEZ AUTOMATICALLY. 4 EXAMPLE, U MITE WANTS 2 chmod 400 UR CONFIG FILEZ (READ PERMISHUN 4 DA OWNR ONLY) OR PUT chattr +i OVAR THEM, IN RESULT DENYIN RITE ACCES 4 EVRYONE, E.G. AS SECURITY MEASURE. USUALLY WE RECOMMEND 2 KEEP TEH CONFIG MIGRASHUN ENABLD, BUT IF U HAS PARTICULAR REASON 4 DISABLIN IT AN WUD INSTEAD PREFR ASF 2 NOT DO DAT, U CAN USE DIS SWITCH 4 ACHIEVIN DAT PURPOSE. KEEP IN MIND HOWEVR, DAT PROVIDIN CORRECT SETTINGS 2 ASF WILL BECOME FRUM NAO ON UR NEW RESPONSIBILITY, ESPECIALLY IN REGARDZ 2 DEPRECASHUNS AN REFACTORS OV PROPERTIEZ IN FUCHUR ASF VERSHUNS.

--no-config-watch - BY DEFAULT ASF SETS UP FileSystemWatcher OVAR UR config DIRECTORY IN ORDR 2 LISTEN 4 EVENTS RELATD 2 FILE CHANGEZ, SO IT CAN INTERACTIVELY ADAPT 2 THEM. 4 EXAMPLE, DIS INCLUDEZ STOPPIN BOTS ON CONFIG DELESHUN, RESTARTIN BOT ON CONFIG BEAN CHANGD, OR LOADIN KEYS INTO BGR ONCE U DROP THEM INTO TEH config DIRECTORY. DIS SWITCH ALLOWS U 2 DISABLE SUCH BEHAVIOUR, WHICH WILL CAUSE ASF 2 COMPLETELY IGNORE ALL TEH CHANGEZ IN config DIRECTORY, REQUIRIN FRUM U 2 DO SUCH ACSHUNS MANUALLY, IF DEEMD APPROPRIATE (WHICH USUALLY MEANZ RESTARTIN TEH PROCES). WE RECOMMEND 2 KEEP TEH CONFIG EVENTS ENABLD, BUT IF U HAS PARTICULAR REASON 4 DISABLIN THEM AN WUD INSTEAD PREFR ASF 2 NOT DO DAT, U CAN USE DIS SWITCH 4 ACHIEVIN DAT PURPOSE.

--no-restart - DIS SWITCH IZ MAINLY USD BY R DOCKR CONTAINERS AN FORCEZ AutoRestart OV false. UNLES U HAS PARTICULAR NED, U SHUD INSTEAD CONFIGURE AutoRestart PROPERTY DIRECTLY IN UR CONFIG. DIS SWITCH IZ HER SO R DOCKR SCRIPT WONT NED 2 TOUCH UR GLOBAL CONFIG IN ORDR 2 ADAPT IT 2 ITZ OWN ENVIRONMENT. OV COURSE, IF URE RUNNIN ASF INNA SCRIPT, U CUD ALSO MAK USE OV DIS SWITCH (OTHERWIZE URE BETTR WIF GLOBAL CONFIG PROPERTY).

--no-steam-parental-generation - BY DEFAULT ASF WILL AUTOMATICALLY ATTEMPT 2 GENERATE STEAM PARENTAL PINS, AS DESCRIBD IN SteamParentalCode CONFIGURASHUN PROPERTY. HOWEVR, SINCE DAT MITE REQUIRE EXCESIV AMOUNT OV OS RESOURCEZ, DIS SWITCH ALLOWS U 2 DISABLE DAT BEHAVIOUR, WHICH WILL RESULT IN ASF SKIPPIN AUTO-GENERASHUN AN GO STRAIGHT 2 ASKIN USR 4 PIN INSTEAD, WHICH IZ WUT WUD NORMALLY HAPPEN ONLY IF TEH AUTO-GENERASHUN HAS FAILD. USUALLY WE RECOMMEND 2 KEEP TEH GENERASHUN ENABLD, BUT IF U HAS PARTICULAR REASON 4 DISABLIN IT AN WUD INSTEAD PREFR ASF 2 NOT DO DAT, U CAN USE DIS SWITCH 4 ACHIEVIN DAT PURPOSE.

--path <path> OR --path=<path> - ASF ALWAYS NAVIGATEZ 2 ITZ OWN DIRECTORY ON STARTUP. BY SPECIFYIN DIS ARGUMENT, ASF WILL NAVIGATE 2 GIVEN DIRECTORY AFTR INITIALIZASHUN, WHICH ALLOWS U 2 USE CUSTOM PATH 4 VARIOUS APPLICASHUN PARTS (INCLUDIN config, logs, plugins AN www DIRECTORIEZ, AS WELL AS NLog.config FILE), WITHOUT NED OV DUPLICATIN BINARY IN DA SAME PLACE. IT CUD COME ESPECIALLY USEFUL IF UD LIEK 2 SEPARATE BINARY FRUM AKSHUL CONFIG, AS IZ DUN IN LINUX-LIEK PACKAGIN - DIS WAI U CAN USE WAN (UP-2-DATE) BINARY WIF SEVERAL DIFFERENT SETUPS. TEH PATH CAN BE EITHR RELATIV ACCORDIN 2 CURRENT PLACE OV ASF BINARY, OR ABSOLUTE. KEEP IN MIND DAT DIS COMMAND POINTS 2 NEW "ASF HOME" - TEH DIRECTORY DAT HAS TEH SAME STRUCCHUR AS ORIGINAL ASF, WIF config DIRECTORY INSIDE, C BELOW EXAMPLE 4 EXPLANASHUN.

DUE 2 TEH NACHUR OV DIS PROPERTY, IZ ALSO POSIBLE 2 SET EXPECTD PATH BY DECLARIN ASF_PATH ENVIRONMENT VARIABLE, WHICH CUD BE MOAR APPROPRIATE 4 PEEPS DAT WUD WANTS 2 AVOID SENSITIV DETAILS IN DA PROCES ARGUMENTS.

IF URE CONSIDERIN USIN DIS COMMAND-LINE ARGUMENT 4 RUNNIN MULTIPLE INSTANCEZ OV ASF, WE RECOMMEND READIN R MANAGEMENT PAEG ON DIS MANNR.

EXAMPLEZ:

dotnet /opt/ASF/ArchiSteamFarm.dll --path /opt/TargetDirectory # Absolute path
dotnet /opt/ASF/ArchiSteamFarm.dll --path ../TargetDirectory # Relative path works as well
ASF_PATH=/opt/TargetDirectory dotnet /opt/ASF/ArchiSteamFarm.dll # Same as env variable

├── 📁 /opt
│     ├── 📁 ASF
│     │     ├── ⚙️ ArchiSteamFarm.dll
│     │     └── ...
│     └── 📁 TargetDirectory
│           ├── 📁 config
│           ├── 📁 logs (generado)
│           ├── 📁 plugins (opcional)
│           ├── 📁 www (opcional)
│           ├── 📄 log.txt (generado)
│           └── 📄 NLog.config (opcional)
└── ...

--service - DIS SWITCH IZ MAINLY USD BY R systemd SERVICE AN FORCEZ Headless OV true. UNLES U HAS PARTICULAR NED, U SHUD INSTEAD CONFIGURE Headless PROPERTY DIRECTLY IN UR CONFIG. DIS SWITCH IZ HER SO R systemd SERVICE WONT NED 2 TOUCH UR GLOBAL CONFIG IN ORDR 2 ADAPT IT 2 ITZ OWN ENVIRONMENT. OV COURSE, IF U HAS SIMILAR NED DEN U CUD ALSO MAK USE OV DIS SWITCH (OTHERWIZE URE BETTR WIF GLOBAL CONFIG PROPERTY).

--system-required - DECLARIN DIS SWITCH WILL CAUSE ASF 2 TRY SIGNALIZIN TEH OS DAT TEH PROCES REQUIREZ SISTEM 2 BE UP AN RUNNIN 4 ITZ ENTIRE LIFETIME. CURRENTLY DIS SWITCH HAS EFFECT ONLY ON WINDOWS MACHINEZ WER ITLL FORBID UR SISTEM FRUM GOIN INTO SLEEP MODE AS LONG AS TEH PROCES IZ RUNNIN. DIS CAN BE PROVEN ESPECIALLY USEFUL WHEN FARMIN ON UR PC OR LAPTOP DURIN NITE, AS ASF WILL BE ABLE 2 KEEP UR SISTEM AWAEK WHILE IZ RUNNIN.