starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Best practice for adding new cli tools #635

New Issue
Closed
opened 2026-01-30 21:57:39 +00:00 by claunia · 7 comments
claunia commented 2026-01-30 21:57:39 +00:00
Owner
Copy Link

Originally created by @rekire on GitHub (Apr 29, 2019).

I'm writing yet another cli tool. I'm thinking about the right way to distribute it.

On mac you can use homebrew to add your cli tools. On Linux you can use apt-get or something similar. If you use node.js you can use npm, for python pip and so on. But what is with Windows?
What is the best way to provide cli tools?

A fat installer with adds that tool to the path variable seems to be very heavy. Asking the user to drop the tool in any directory with is in the path variable is dirty as hell. I personally still prefer cmd over ps, since I know how it works ps is out of my view much more complex.

If the Microsoft Store is the preferred way please provide me an example and a tutorial how to achieve that. I'm not familiar with the Store at all.

Originally created by @rekire on GitHub (Apr 29, 2019). I'm writing yet another cli tool. I'm thinking about the right way to distribute it. On mac you can use homebrew to add your cli tools. On Linux you can use apt-get or something similar. If you use node.js you can use npm, for python pip and so on. But what is with Windows? What is the _best_ way to provide cli tools? A fat installer with adds that tool to the path variable seems to be very heavy. Asking the user to drop the tool in any directory with is in the path variable is dirty as hell. I personally still prefer cmd over ps, since I know how it works ps is out of my view much more complex. If the Microsoft Store is the preferred way please provide me an example and a tutorial how to achieve that. I'm not familiar with the Store at all.
claunia added the Issue-QuestionResolution-AnsweredArea-InteropProduct-Cmd.exe labels 2026-01-30 21:57:39 +00:00
claunia commented 2026-01-30 21:57:40 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Apr 29, 2019):

https://docs.microsoft.com/en-us/windows/uwp/launch-resume/console-uwp

@oising commented on GitHub (Apr 29, 2019): https://docs.microsoft.com/en-us/windows/uwp/launch-resume/console-uwp
claunia commented 2026-01-30 21:57:40 +00:00
Author
Owner
Copy Link

@rekire commented on GitHub (Apr 29, 2019):

This looks like a guide how to write a console application, I already wrote one in Kotlin. My question was how to publish it.

@rekire commented on GitHub (Apr 29, 2019): This looks like a guide how to write a console application, I already wrote one in Kotlin. My question was how to publish it.
claunia commented 2026-01-30 21:57:41 +00:00
Author
Owner
Copy Link

@miniksa commented on GitHub (Apr 29, 2019):

There is no definitive best way today for Windows to provide cli tools.

We would likely recommend listing it in https://chocolatey.org/ as a package manager type application for Windows.

But you probably also would want to provide it as your own drop on your website either as a ZIP or an MSI for people to install however they choose.

And lastly, you may want to adapt it into a Console UWP package so you could distribute it via the Windows Store per @oising's link above.

We know this is an area that we need to improve messaging and guidance on, but I don't have anything further for you at this time.

@miniksa commented on GitHub (Apr 29, 2019): There is no definitive best way today for Windows to provide cli tools. We would likely recommend listing it in https://chocolatey.org/ as a package manager type application for Windows. But you probably also would want to provide it as your own drop on your website either as a ZIP or an MSI for people to install however they choose. And lastly, you may want to adapt it into a Console UWP package so you could distribute it via the Windows Store per @oising's link above. We know this is an area that we need to improve messaging and guidance on, but I don't have anything further for you at this time.
claunia commented 2026-01-30 21:57:41 +00:00
Author
Owner
Copy Link

@rekire commented on GitHub (Apr 29, 2019):

So that Console UWP package could be a solution, but how do I bake an app from a batch file and a jar file? Sorry I know that is a stupid question, but I'm not familiar with that.

@rekire commented on GitHub (Apr 29, 2019): So that Console UWP package could be a solution, but how do I bake an app from a batch file and a jar file? Sorry I know that is a stupid question, but I'm not familiar with that.
claunia commented 2026-01-30 21:57:42 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Apr 29, 2019):

@rekire - given that it's a batch wrapper around a jar file, it's probably not the best candidate for the Windows Store. I'd go with @miniksa and recommend packaging it up as a chocolatey delivery. This is as close as we've got on windows to apt.

@oising commented on GitHub (Apr 29, 2019): @rekire - given that it's a batch wrapper around a jar file, it's probably not the best candidate for the Windows Store. I'd go with @miniksa and recommend packaging it up as a chocolatey delivery. This is as close as we've got on windows to apt.
claunia commented 2026-01-30 21:57:42 +00:00
Author
Owner
Copy Link

@rekire commented on GitHub (Apr 29, 2019):

I could translate my very simple batch file to a simple c++ program it that makes things easier. However I'm still not sure what steps I would need to do. Code signing is one critical part isn't it?

Regarding chocolatey, sounds interesting, but I never read about it. Is that very common?

@rekire commented on GitHub (Apr 29, 2019): I could translate my very simple batch file to a simple c++ program it that makes things easier. However I'm still not sure what steps I would need to do. Code signing is one critical part isn't it? Regarding chocolatey, sounds interesting, but I never read about it. Is that very common?
claunia commented 2026-01-30 21:57:42 +00:00
Author
Owner
Copy Link

@oising commented on GitHub (Apr 29, 2019):

Yep, chocolatey is pretty common - especially in enterprises. Tbh, I'd stay away from the windows store; it's a walled garden intended for commerical efforts designed to span multiple platforms. Go check out https://chocolatey.org/

@oising commented on GitHub (Apr 29, 2019): Yep, chocolatey is pretty common - especially in enterprises. Tbh, I'd stay away from the windows store; it's a walled garden intended for commerical efforts designed to span multiple platforms. Go check out https://chocolatey.org/
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-Interop Issue-Question Product-Cmd.exe Resolution-Answered
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#635
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?