@dosu/cli 0.1.6 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +66 -13
  2. package/bin/dosu.js +5166 -0
  3. package/package.json +38 -13
  4. package/bin/dosu +0 -59
package/README.md CHANGED
@@ -1,11 +1,13 @@
1
- # @dosu/cli
1
+ # dosu-cli
2
2
 
3
3
  ## ⚠️ Pre-Release:
4
4
  The Dosu CLI is pre-release alpha software and is not fully supported currently. Please check back soon. Join our [Discord](https://go.dosu.dev/discord-cli) so you'll be the first to know when it's launched!
5
5
 
6
6
  ## Installation
7
7
 
8
- ### npm
8
+ ### npx / npm (Recommended)
9
+
10
+ Requires Node.js 18+.
9
11
 
10
12
  ```bash
11
13
  npx @dosu/cli setup
@@ -18,27 +20,78 @@ npm install -g @dosu/cli
18
20
  dosu setup
19
21
  ```
20
22
 
23
+ ### curl / install (macOS / Linux)
24
+
25
+ Downloads and installs the latest stable release binary.
26
+
27
+ ```bash
28
+ curl -fsSL https://raw.githubusercontent.com/dosu-ai/dosu-cli/main/install.sh | sh
29
+ ```
30
+
31
+ To install a specific release tag:
32
+
33
+ ```bash
34
+ DOSU_INSTALL_VERSION=v0.2.0-rc1 curl -fsSL https://raw.githubusercontent.com/dosu-ai/dosu-cli/main/install.sh | sh
35
+ ```
36
+
21
37
  ### Homebrew
22
38
 
23
39
  ```bash
24
40
  brew install dosu-ai/dosu/dosu
25
41
  ```
26
42
 
43
+ Or tap first:
44
+
45
+ ```bash
46
+ brew tap dosu-ai/dosu
47
+ brew install dosu
48
+ ```
49
+
27
50
  ### Manual Download
28
51
 
29
52
  Download the appropriate archive from the [Releases](https://github.com/dosu-ai/dosu-cli/releases) page.
30
53
 
31
- ## Supported Platforms
54
+ #### macOS Gatekeeper Warning
55
+
56
+ When downloading directly from GitHub releases on macOS, you may see:
57
+
58
+ > "Apple could not verify dosu is free of malware that may harm your Mac or compromise your privacy."
59
+
60
+ This happens because the binary is not signed with an Apple Developer certificate. To bypass this:
61
+
62
+ ```bash
63
+ # After extracting the archive, remove the quarantine attribute:
64
+ xattr -d com.apple.quarantine ./dosu
65
+ ```
66
+
67
+ Or right-click the binary, select "Open", and click "Open" in the dialog.
68
+
69
+ **Note:** Installing via Homebrew avoids this issue automatically.
70
+
71
+ ## Releasing (for maintainers)
72
+
73
+ Releases are automated via `bun build --compile` and GitHub Actions.
74
+
75
+ ### Creating a Release
76
+
77
+ 1. **Ensure all changes are committed and pushed to `main`**
78
+
79
+ 2. **Create and push a new tag:**
80
+ ```bash
81
+ git tag v0.2.0
82
+ git push origin v0.2.0
83
+ ```
84
+
85
+ 3. **GitHub Actions will automatically:**
86
+ - Run tests
87
+ - Build binaries for all platforms (macOS, Linux, Windows)
88
+ - Create a GitHub release with the binaries
89
+ - Publish to npm (`@dosu/cli`)
90
+ - Update the Homebrew formula
32
91
 
33
- | OS | Architecture |
34
- |---------|-------------|
35
- | macOS | ARM64 (Apple Silicon) |
36
- | macOS | x64 (Intel) |
37
- | Linux | ARM64 |
38
- | Linux | x64 |
39
- | Windows | x64 |
92
+ ### Version Naming
40
93
 
41
- ## Links
94
+ - Production releases: `v1.0.0`, `v1.1.0`, `v2.0.0`
95
+ - Pre-releases: `v0.1.0-alpha`, `v0.1.0-beta`, `v0.1.0-rc1`
42
96
 
43
- - [GitHub](https://github.com/dosu-ai/dosu-cli)
44
- - [Discord](https://go.dosu.dev/discord-cli)
97
+ Pre-release tags (containing `-alpha`, `-beta`, `-rc`) are automatically marked as pre-releases on GitHub and published to npm under the `next` dist-tag.