Skip to content
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.

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

Add example browsing and copying from the command line #146

Open
markgsaunders opened this issue Jun 24, 2024 · 3 comments
Open

Add example browsing and copying from the command line #146

markgsaunders opened this issue Jun 24, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@markgsaunders
Copy link

From the command line (bash), CMSIS does not have a simple means of creating applications from a vendor's set of examples. In uVision and Keil Studio the installed packs are scoured for examples and the user can browse them, choose one, and ask the tool to create a project for it. On the command line, however, the user has to find the examples and manually copy the contents from a github repo, the CMSIS_PACK_ROOT folder, or elsewhere. It's not the most robust situation because it entails manually pulling parts from the vendor's folder structure, and presupposes some user knowledge of where to look.
I think the csolution program, which already has commands like list packs and list boards, could be extended to list examples. This would at least tell the user where to find "blinky".
Adding to that, it would be fantastic if csolution (or some other program) could be used to make a copy of the example by specifying the source pack, version, and example. As a user I could then use csolution to browse for examples (csolution list examples) and then reliably create a copy of one in seconds (csolution Vendor::[email protected] blinky).

@jkrech jkrech added the enhancement New feature or request label Jun 25, 2024
@jkrech jkrech changed the title Suggestion - enable example browsing and copying from csolution command Add example browsing and copying from the command line Jun 25, 2024
@jkrech
Copy link
Member

jkrech commented Jun 25, 2024

In the absence of accessing this information from the command line, we recommend to users to locate the examples for a specific board/device from keil.arm.com offering to download zip archives
e.g. https://www.keil.arm.com/boards/infineon-xmc4200-cpu-board-actuator-cpu-42a-v2-341e782/projects/
or use the CMSIS Solution VSCode Extension - New Solution flow and select from available examples after selecting a target.

@ReinhardKeil
Copy link
Collaborator

@markgsaunders thanks for raising it - we will review.

We have a similar request already here Open-CMSIS-Pack/devtools#1323

@markgsaunders
Copy link
Author

Yes, this is an enhancement or usability issue rather than something that cannot be solved by the user any other way. But I think it would be a valuable addition!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants