processing cli --help links to old repository

[DinoWw]

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 --help from 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

1. install processing

2. run processing cli --help

3. read 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

[SableRaf]

Hi @DinoWw and thanks for the report. I have assigned you. Let us know if you need any pointers!

[DinoWw]

@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?

[glvjr]

Hello,

I support a new processing cli wiki added to this repository.

Additionally:

• Transitioning to the new processing cli is a challenge with all the references out there from the past.
• A note in each of the repository wikis about the transition to processing cli in the latest versions.
• Add a link in the old processing-java wiki to the new processing cli wiki.
• Add a link in the new processing cli wiki to the old processing-java wiki for those using older versions of Processing.

Update this:
https://processing.org/environment/#command-line-interface-cli

• Add an example for processing cli --help for each OS.
• Add a link to the processing cli wiki in this repository once that is completed.

Command line is always a challenge for inexperienced users.

Related:
#1306 (comment)

[DinoWw]

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 --help output.

As for the changes in the webpage, I will open a new issue on that repository.

[SableRaf]

Getting back to this after the holidays.

For context: starting with Processing 4.4.3, processing-java was renamed to processing cli (see PR #1050).

Since the new CLI will continue to evolve, we decided to treat the --help output 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 --help command.

I’d be in favor of delaying further work on the wiki until the processing cli feature set is more complete, to avoid spending time on documentation that will quickly become outdated.

[SableRaf]

@Stefterv I'm on macOS. What is the difference between ./Processing --help ./Processing cli --help and why do they have different outputs?

[DinoWw]

The Processing command launches the gui ide and opens the sketch supplied as the argument. Processing cli runs 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 sketch

processing cli --help

Command 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]

@Stefterv I'm on macOS. What is the difference between ./Processing --help ./Processing cli --help and why do they have different outputs?

processing cli is a 1:1 translation of the old processing-java cli, 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

[catilac]

@Stefterv @SableRaf is this a good first issue? can i assign this to a university classroom?