PrincessPi/esp-idf-tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme .

Browse Source
This commit is contained in:
Princess Pi
2025-04-30 16:57:42 -06:00
parent bee2ec4244
commit 87ab34c227
2 changed files with 38 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+37 -33
View File
@@ -36,72 +36,76 @@ Literally the most schizophrenically overengineered thing I have ever made. idk
## Usage ## Usage
``` ```
Modes: Modes:
each of these arguments can be used identically on the alias run_esp_reinstall each of these arguments can be used identically on the alias run_esp_cmd
default: default:
reinstalls non-interactively with no delays, logouts, or reboots. run without any argument reinstalls non-interactively with no delays, logouts, or reboots. run without any argument
bash esp-idf-tools-cmd.sh run_esp_cmd
test: test:
tests the script. very fast. minimal actions taken. no reinstall is done tests the script. very fast. minimal actions taken. no reinstall is done
bash esp-idf-tools-cmd.sh test run_esp_cmd test
bash esp-idf-tools-cmd.sh t run_esp_cmd t
retool: retool:
reinstalls bins and export.sh, nothing else reinstalls bins and export.sh, nothing else
bash esp-idf-tools-cmd.sh retool run_esp_cmd retool
bash esp-idf-tools-cmd.sh rt run_esp_cmd rt
cron: cron:
runs noninteractively with forced user logout and automatic reboot, plus delays runs noninteractively with forced user logout and automatic reboot, plus delays
bash esp-idf-tools-cmd.sh cron run_esp_cmd cron
bash esp-idf-tools-cmd.sh c run_esp_cmd c
update:
runs update like cron but without logout or reboot
run_esp_cmd update
run_esp_cmd u
interactive: interactive:
interactively installs/reinstalls esp-idf interactively installs/reinstalls esp-idf
bash esp-idf-tools-cmd.sh interactive run_esp_cmd interactive
bash esp-idf-tools-cmd.sh i run_esp_cmd i
nuke: nuke:
full delete and re-download and install full delete and re-download and install
bash esp-idf-tools-cmd.sh nuke run_esp_cmd nuke
bash esp-idf-tools-cmd.sh n run_esp_cmd n
clearlogs: clearlogs:
clear logs clear logs
bash esp-idf-tools-cmd.sh clearlogs run_esp_cmd clearlogs
bash esp-idf-tools-cmd.sh clear run_esp_cmd clear
bash esp-idf-tools-cmd.sh clean run_esp_cmd clean
bash esp-idf-tools-cmd.sh cl run_esp_cmd cl
help: help:
display this help text display this help text
bash esp-idf-tools-cmd.sh help run_esp_cmd help
bash esp-idf-tools-cmd.sh h run_esp_cmd h
bash esp-idf-tools-cmd.sh -h run_esp_cmd -h
bash esp-idf-tools-cmd.sh --help run_esp_cmd --help
uninstall: uninstall:
uninstall esp-idf run_esp_cmd uninstall
bash esp-idf-tools-cmd.sh uninstall
``` ```
## Ailases ## Ailases
``` ```
run_esp_reinstall run_esp_cmd
Updates the esp-install-custom code via git, displays the script version, then executes esp-idf-tools-cmd.sh with optional arument. Updates the esp-install-custom code via git, displays the script version, then executes esp-idf-tools-cmd.sh with optional arument.
Takes identical arguments to running esp-idf-tools-cmd.sh manually Takes identical arguments to running esp-idf-tools-cmd.sh manually
run_esp_reinstall run_esp_cmd
run_esp_reinstall clean run_esp_cmd clean
run_esp_reinstall nuke run_esp_cmd nuke
run_esp_reinstall retool run_esp_cmd retool
run_esp_reinstall cron run_esp_cmd cron
run_esp_reinstall interactive run_esp_cmd update
run_esp_reinstall test run_esp_cmd interactive
run_esp_reinstall help run_esp_cmd test
run_esp_reinstall uninstall run_esp_cmd help
run_esp_cmd uninstall
Second optional argument specifies branch: Second optional argument specifies branch:
`run_esp_reinstall nuke v5.4.1` `run_esp_cmd nuke v5.4.1`
esp_install_monitor esp_install_monitor
monitors install.log monitors install.log
esp-idf-tools-cmd.sh
+1 -1
View File
@@ -264,7 +264,7 @@ function testAppendAlias() {
function handleAliasEnviron() { function handleAliasEnviron() {
testAppendAlias "get_idf" "alias get_idf='. $exportScript'" testAppendAlias "get_idf" "alias get_idf='. $exportScript'"
testAppendAlias "run_esp_reinstall" "alias run_esp_reinstall='git -C $runningDir pull;echo -e \"\nOld Version:\";tail -1 $versionData;echo -e \"\n\";bash $runningDir/esp-idf-tools-cmd.sh'" testAppendAlias "run_esp_cmd" "alias run_esp_reinstall='git -C $runningDir pull;echo -e \"\nOld Version:\";tail -1 $versionData;echo -e \"\n\";bash $runningDir/esp-idf-tools-cmd.sh'"
testAppendAlias "esp_install_monitor" "alias esp_install_monitor='tail -n 75 -f $log'" testAppendAlias "esp_install_monitor" "alias esp_install_monitor='tail -n 75 -f $log'"
testAppendAlias "esp_install_logs" "alias esp_install_logs='less $versionData;less $log'" testAppendAlias "esp_install_logs" "alias esp_install_logs='less $versionData;less $log'"