Repository navigation
processing cli --help links to old repository #1366
Description
Activity
@SableRaf Hi, this is my first time contributing to a project.
My thinking is I either update the old wiki page with the info for the new command, which seems off given the repository is retired. Or i copy that page to this repo's wiki and update it, then change the link that the help command returns.Does the second option seem ok?
Hello,
I support a new
processing cliwiki added to this repository.Additionally:
- Transitioning to the new
processing cliis a challenge with all the references out there from the past. - A note in each of the repository wikis about the transition to
processing cliin the latest versions. - Add a link in the old
processing-javawiki to the newprocessing cliwiki. - Add a link in the new
processing cliwiki to the oldprocessing-javawiki for those using older versions of Processing.
Update this:
https://processing.org/environment/#command-line-interface-cli- Add an example for
processing cli --helpfor each OS. - Add a link to the
processing cliwiki in this repository once that is completed.
Command line is always a challenge for inexperienced users.
Related:
#1306 (comment)- Transitioning to the new
I see the wiki pages in this and the old repository got updated, I will make a PR with the link changed in the
processing cli --helpoutput.As for the changes in the webpage, I will open a new issue on that repository.
Getting back to this after the holidays.
For context: starting with Processing 4.4.3,
processing-javawas renamed toprocessing cli(see PR #1050).Since the new CLI will continue to evolve, we decided to treat the
--helpoutput as the source of truth rather than make a detailed wiki page. This will make sure users always see information that matches the version of Processing they have installed.As a quick fix for now, I’ve done the following:
- Created a new page on the processing4 wiki.
- Added a warning and link to the original page.
@Stefterv just opened a new draft PR (see PR #1377) to simplify setting up the new cli on macOS and add an info message linking ppl to the wiki page.
@DinoWw If you are still up for picking this up, feel free to make a PR linking to the new page in the
--helpcommand.I’d be in favor of delaying further work on the wiki until the
processing clifeature set is more complete, to avoid spending time on documentation that will quickly become outdated.Reacted by glvThe
Processingcommand launches the gui ide and opens the sketch supplied as the argument.Processing cliruns the sketch instead.The PR I made is linked in the discussion above (#1378). Below are outputs of the help commands as they stand.
processing --help:Usage: processing [<options>] [<sketches>]... <command> [<args>]... Start the Processing IDE Options: -v, --version Print version information -h, --help Show this message and exit Arguments: <sketches> Sketches to open Commands: lsp Start the Processing Language Server cli contributions Manage Processing contributions sketchbook Manage the sketchbook sketch Manage a Processing sketchprocessing cli --helpCommand line edition for Processing 4.4.10 (Java Mode) --help Show this help text. Congratulations. --sketch=<name> Specify the sketch folder (required) --output=<name> Specify the output folder (optional and cannot be the same as the sketch folder.) --force The sketch will not build if the output folder already exists, because the contents will be replaced. This option erases the folder first. Use with extreme caution! --build Preprocess and compile a sketch into .class files. --run Preprocess, compile, and run a sketch. --present Preprocess, compile, and run a sketch in presentation mode. --export Export an application. --variant Specify the platform and architecture (Export only). --no-java Do not embed Java. Starting with 4.0, the --platform option has been removed because of the variety of platforms and architectures now available. Use the --variant option instead, for instance: variant platform ------------- --------------------------- macos-x86_64 macOS (Intel 64-bit) macos-aarch64 macOS (Apple Silicon) windows-amd64 Windows (Intel 64-bit) linux-amd64 Linux (Intel 64-bit) linux-arm Linux (Raspberry Pi 32-bit) linux-aarch64 Linux (Raspberry Pi 64-bit) The --build, --run, --present, or --export must be the final parameter passed to Processing. Arguments passed following one of those four will be passed through to the sketch itself, and therefore available to the sketch via the 'args' field. To pass options understood by PApplet.main(), write a custom main() method so that the preprocessor does not add one. https://github.com/processing/processing/wiki/Command-Line@Stefterv I'm on macOS. What is the difference between
./Processing --help./Processing cli --helpand why do they have different outputs?processing cliis a 1:1 translation of the oldprocessing-javacli, so to make sure the interface only changes on the command and nothing else I didn't touch anything downstream. I can imagine someone reads that to make sure which platforms are available for example
Most appropriate sub-area of Processing 4?
Utilities
Processing version
4.4.10, confirmed on build from main branch
Operating system
Linux
Bug description
Running
processing cli --helpfrom the command line links to https://github.com/processing/processing/wiki/Command-Line.The page explains the behavior of the processing-java command, although the flags available seem to match.
The existence of the page linked can confuse users as it did me.
Steps to reproduce this
install processing
run
processing cli --helpread the bottom of the output
snippet
No response
Additional context
No response
Would you like to work on the issue?
Yes, I’d like to help with this