You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-20Lines changed: 29 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,8 @@
1
+
# Windows App Development CLI
2
+
3
+
> [!IMPORTANT]
4
+
> :warning:**Status: Public Preview** - The Windows App Development CLI is experimental and in active development. We'd love your feedback! Share your thoughts by creating an [issue](https://github.com/microsoft/WinAppCli/issues).
> The Windows App Development CLI is in preview and in active development, and we'd love your feedback! Share your thoughts by creating an [issue](https://github.com/microsoft/WinAppCli/issues).
25
+
<br/>
24
26
25
27
The Windows App Development CLI is a single command-line interface for managing Windows SDKs, packaging, generating app identity, manifests, certificates, and using build tools with any app framework. This tool bridges the gap between cross-platform development and Windows-native capabilities.
26
28
<br/><br/>
27
29
Whether you're building with Electron, .NET/Win32, CMake, or Python, this CLI gives you access to:
28
30
29
-
-**Modern Windows APIs** - Windows App SDK and Windows SDK with automatic setup and code generation
31
+
-**Modern Windows APIs** - [Windows App SDK](https://learn.microsoft.com/windows/apps/windows-app-sdk/) and Windows SDK with automatic setup and code generation
30
32
-**App Identity** - Debug and test by adding app identity without full packaging in a snap
31
33
-**MSIX Packaging** - App packaging with signing and Store readiness
32
34
-**Developer Tools** - Manifests, certificates, assets, and build integration
@@ -53,7 +55,9 @@ The easiest way to use the CLI is to download the latest build from GitHub Relea
53
55
54
56
### Adding to Path
55
57
56
-
The easiest way to use the CLI globally is to install it via the MSIX installer
58
+
The easiest way to use the CLI globally is to install it via the [MSIX installer](https://github.com/microsoft/WinAppCli/releases/latest).
59
+
60
+
You can also add it manually: Windows Search → Edit the system environment variables → Environment Variables → Path → Edit → New → Add the location (folder) of winapp CLI.
57
61
58
62
## 📋 Usage
59
63
@@ -105,25 +109,30 @@ The full CLI usage can be found here: [Documentation](/docs/usage.md)
105
109
-[File an issue, feature request or bug](https://github.com/microsoft/WinAppCli/issues): please ensure that you are not filing a duplicate issue
106
110
- Send feedback to <[email protected]>: Do you love this tool? Are there features or fixes you want to see? Let us know!
107
111
108
-
We are actively working on improving Node and Python support. These features are currently experimental and we are aware of several issues with these app types.
112
+
We are actively working on improving Node and Python support. These features are experimental and we are aware of several issues with these app types.
109
113
110
114
## 🧪 Try the Windows Identity App
111
115
112
-
This repository also contains an **experimental** app (GUI) that wraps the CLI and provides an intuitive, drag-and-drop experience. [See the docs](/docs/gui-usage.md) for more details.
116
+
This repository also contains an **experimental** app (GUI) that wraps the CLI and provides an intuitive, drag-and-drop experience. [See the docs](/docs/gui-usage.md) for more details. [Download the app here](https://github.com/microsoft/WinAppCli/releases/tag/v0.1.1-gui).
117
+
118
+
## 🧾 Samples
119
+
120
+
This repository will continue to be added with samples. Currently the following samples exist:
121
+
122
+
-[Electron sample](/samples/electron/README.md): a default Electron Forge generated application + initialized a winapp project with appxmanifest, assets + native addon + C# addon + generates cert
123
+
124
+
## Support
125
+
126
+
Need help or have questions about the Windows App Development CLI? Visit our **[Support Guide](./SUPPORT.md)** for information about our issue templates and triage process.
113
127
114
128
## Contributing
115
129
116
-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
117
-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
118
-
the rights to use your contribution. For details, visit [Contributor License Agreements](https://cla.opensource.microsoft.com).
130
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [Contributor License Agreements](https://cla.opensource.microsoft.com).
119
131
120
-
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
121
-
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
122
-
provided by the bot. You will only need to do this once across all repos using our CLA.
132
+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
123
133
124
134
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
125
-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
# TODO: The maintainer of this repo has not yet edited this file
1
+
# Support
2
2
3
-
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
3
+
## How to file issues and get help
4
4
5
-
-**No CSS support:** Fill out this template with information about how to file issues and get help.
6
-
-**Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
7
-
-**Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
5
+
This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates.
8
6
9
-
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
7
+
### Filing Issues
10
8
11
-
# Support
9
+
We have specific issue templates to help you provide the right information:
10
+
11
+
-**[Bug Report](https://github.com/microsoft/WinAppCli/issues/new?template=bug-report.md)** - Report something that isn't working correctly
12
+
-**[Feature Request](https://github.com/microsoft/WinAppCli/issues/new?template=feature_request.md)** - Suggest a new feature or enhancement
13
+
-**[General Issues](https://github.com/microsoft/WinAppCli/issues)** - File any other type of issue or browse existing issues
14
+
15
+
Please ensure that you are not filing a duplicate issue by searching existing issues first.
16
+
17
+
### Getting Help
18
+
19
+
For help and questions about using this project:
20
+
21
+
1. Check our [documentation](./docs/usage.md) for detailed usage instructions
22
+
2. Browse existing [GitHub Issues](https://github.com/microsoft/WinAppCli/issues) for similar questions
23
+
3. File a new issue with the `question` label if you need additional help
24
+
25
+
## Issue Triage
26
+
27
+
Our team actively monitors and manages issues in this repository.
28
+
29
+
-**Bug Reports and questions**: Critical bugs are prioritized and addressed as quickly as possible. Questions will be monitored.
30
+
-**Feature Requests**: Evaluated during regular planning cycles
31
+
32
+
### When a New Issue is Created
33
+
34
+
All new issues are automatically reviewed and tagged with appropriate labels:
-**Framework/language**: `dotnet`, `electron`, `javascript`, `python`, `gui` (based on the affected area)
38
+
-**Priority**: `good first issue`, `help wanted` (for community contribution opportunities)
39
+
40
+
### Investigation
41
+
42
+
As we investigate and work on issues, additional labels are applied:
43
+
44
+
-**`known-issue`** - Applied to issues the team has identified and is tracking
45
+
-**`needs:docs`** - Issues that require documentation updates or clarification
46
+
-**`dependencies`** - Issues related to external dependency updates
12
47
13
-
##How to file issues and get help
48
+
### Closing Issues
14
49
15
-
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
16
-
issues before filing new issues to avoid duplicates. For new issues, file your bug or
17
-
feature request as a new Issue.
50
+
When closing issues, we apply final classification labels:
18
51
19
-
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
20
-
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
21
-
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
52
+
-**`duplicate`** - Issue already reported elsewhere (includes link to original)
53
+
-**`invalid`** - Issue doesn't seem right or cannot be reproduced
54
+
-**`wontfix`** - Issue will not be addressed (with explanation in comments)
22
55
23
-
## Microsoft Support Policy
56
+
## Microsoft Support Policy
24
57
25
-
Support for this **PROJECT or PRODUCT**is limited to the resources listed above.
58
+
Support for the Windows App Development CLI is limited to the resources listed above. This is an open-source project maintained by Microsoft, and community contributions are welcome.
0 commit comments