mfhelp 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. #!/usr/bin/env bash
  2. #
  3. # mfhelp
  4. #
  5. cat <<THIS
  6. Marlin Firmware Commands:
  7. firstpush ... Push and set-upstream the current branch to 'origin'
  8. ghpc ........ Push the current branch to its upstream branch
  9. ghtp ........ Set the transfer protocol for all your remotes
  10. mfadd ....... Fetch a remote branch from any Marlin fork
  11. mfclean ..... Attempt to clean up merged and deleted branches
  12. mfdoc ....... Build the website, serve locally, and browse
  13. mfenvs ...... Get current board SHORT_NAME (###): [ env1 env2 ... ]
  14. mffp ........ Push new commits directly to MarlinFirmware
  15. mfinfo ...... Provide branch information (for the other scripts)
  16. mfinit ...... Create an 'upstream' remote for 'MarlinFirmare'
  17. mfnew ....... Create a new branch based on 'bugfix-...'
  18. mfpr ........ Push the current branch and open the PR form
  19. mfpub ....... Build and publish the marlinfw.org website
  20. mfqp ........ Commit changes, do an interactive rebase, and push
  21. mfrb ........ Interactively rebase the current branch on 'bugfix-...'
  22. mftest ...... Run a platform test locally with PlatformIO
  23. mfup ........ Fetch the latest 'upstream' and rebase on it
  24. Enter [command] --help for more information.
  25. Build / Test Commands:
  26. mftest ............... Run a platform test locally with PlatformIO
  27. build_all_examples ... Build all configurations of a branch, stop on error
  28. Modify Configuration.h / Configuration_adv.h:
  29. opt_add .............. Add a configuration option (to the top of Configuration.h)
  30. opt_disable .......... Disable a configuration option (modifies )
  31. opt_enable ........... Enable a configuration option
  32. opt_set .............. Set the value of a configuration option
  33. use_example_configs .. Download configs from a remote branch on GitHub
  34. Modify pins files:
  35. pinsformat.py ........ Python script to format pins files
  36. THIS