Skip to content

Arduino CLI build tool dependencies are undocumented #1558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
3 tasks done
Tracked by #815
nbourre opened this issue Oct 13, 2022 · 3 comments
Closed
3 tasks done
Tracked by #815

Arduino CLI build tool dependencies are undocumented #1558

nbourre opened this issue Oct 13, 2022 · 3 comments
Assignees
@per1234
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Comments

@nbourre
Copy link
Contributor

nbourre commented Oct 13, 2022 •
edited by per1234
Loading

Describe the problem

After following the instructions to compile Arduino IDE under Windows, I stumbled on this error after running yarn.

arduino-ide-extension: <<< Checked out c8ff042.
arduino-ide-extension: >>> Building the CLI...
arduino-ide-extension: 'task' is not recognized as an internal or external command,
arduino-ide-extension: operable program or batch file.
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
lerna ERR! yarn run prepare exited 1 in 'arduino-ide-extension'
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

I'm unable to compile this project, even though I installed all the dependencies that are specified in the Development Guide:

https://github.com/arduino/arduino-ide/blob/main/docs/development.md

To reproduce

Call yarn in the Arduino IDE source code folder.

Expected behavior

The Development Guide provides instructions for installing all dependencies.

Arduino IDE version

Arduino IDE source code

Operating system

Windows

Operating system version

10.0.22623.741

Additional context

The fault occurs only when the Arduino CLI dependency is pinned to a non-release ref. In this case, the following tools are required:

  • Task
  • Go
  • Posix shell

In addition to documenting this information, it would be helpful if the script that invokes task first checked if the executable was available in the system path (similar to the shell which builtin) and if not printed a helpful error message explaining that user must install the dependency.

Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the latest nightly build
  • My report contains all necessary details
@nbourre nbourre added the type: imperfection Perceived defect in any part of project label Oct 13, 2022
@per1234
Copy link
Contributor

per1234 commented Oct 13, 2022 •
edited
Loading

Thanks for reporting this @nbourre. You are correct this is an undocumented development tool dependency. We'll be sure to add it to the Development Guide.

Please install Task by following the instructions here:

https://taskfile.dev/installation

(my own preferred approach is to simply download the binary from the "task_windows_amd64.zip" link under the "Assets" section of the Releases page)

After that, add the Task installation location to your system PATH by following the instructions here:

https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)

@per1234 per1234 self-assigned this Oct 13, 2022
@per1234 per1234 added the topic: documentation Related to documentation for the project label Oct 13, 2022
@nbourre
Copy link
Contributor Author

nbourre commented Oct 13, 2022

Thanks @per1234. I fixed the Task missing executable, but this brings the following errors.

arduino-ide-extension: <<< Checked out c8ff042.
arduino-ide-extension: >>> Building the CLI...
arduino-ide-extension: "tr": executable file not found in $PATH
arduino-ide-extension: "grep": executable file not found in $PATH
arduino-ide-extension: "go": executable file not found in $PATH
arduino-ide-extension: "date": executable file not found in $PATH
arduino-ide-extension: "head": executable file not found in $PATH
arduino-ide-extension: task: [go:build] go build -v -ldflags ' -X github.com/arduino/arduino-cli/version.versionString=git-snapshot -X github.com/arduino/arduino-cli/version.commit=c8ff0425 -X github.com/arduino/arduino-cli/version.date= '
arduino-ide-extension: "go": executable file not found in $PATH
arduino-ide-extension: task: Failed to run task "go:build": exit status 127
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
lerna ERR! yarn run prepare exited 1 in 'arduino-ide-extension'
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

While searching these executable files, it seems they are related to Visual Studio Build Tools. Curiously, I do have Visual Studio 2019 installed on my machine.

I'm still missing go executable which I guess is related to the go programming language. So I installed it from here.

Installing go seems to have fixed the problem.

As a C# developer, it is quite impressive all the tools required to compile the source code! 😆

@per1234 per1234 mentioned this issue Oct 13, 2022
Open
9 tasks
@per1234 per1234 changed the title Developer guide : Compiling Arduino IDE error Arduino CLI build tool dependencies are undocumented Mar 10, 2025
@per1234
Copy link
Contributor

per1234 commented Apr 28, 2025

Closing as resolved by #2531

@per1234 per1234 closed this as completed Apr 28, 2025
@per1234 per1234 added the conclusion: resolved Issue was resolved label Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@per1234 per1234

Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nbourre @per1234