bktide 1.0.1755655078 → 1.0.1765203819
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.
- package/README.md +29 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -37,25 +37,35 @@ echo 'source <(bktide completions zsh)' >> ~/.zshrc
|
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
Completions provide:
|
|
40
|
-
- Command suggestions (`bktide <Tab>`)
|
|
41
|
-
- Option completions (`bktide builds --<Tab>`)
|
|
42
|
-
- Value completions (`bktide --format <Tab>`)
|
|
40
|
+
- Command suggestions (ie `bktide <Tab>`)
|
|
41
|
+
- Option completions (ie `bktide builds --<Tab>`)
|
|
42
|
+
- Value completions (ie `bktide --format <Tab>`)
|
|
43
43
|
- Dynamic completions for organizations and pipelines (Fish with jq installed)
|
|
44
44
|
|
|
45
45
|
See [Shell Completions Guide](docs/shell-completions.md) for detailed installation and troubleshooting.
|
|
46
46
|
|
|
47
47
|
## Documentation
|
|
48
48
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
- [
|
|
53
|
-
- [
|
|
54
|
-
- [
|
|
55
|
-
- [Troubleshooting](docs/troubleshooting.md) - Common issues and solutions
|
|
56
|
-
- [Alfred Integration
|
|
57
|
-
|
|
58
|
-
|
|
49
|
+
Our documentation is organized by audience to help you find what you need:
|
|
50
|
+
|
|
51
|
+
### 📖 [User Documentation](docs/user/) - For end users
|
|
52
|
+
- [Getting Started](docs/user/getting-started.md) - Quick start guide for new users
|
|
53
|
+
- [Authentication](docs/user/authentication.md) - How to authenticate with Buildkite
|
|
54
|
+
- [Shell Completions](docs/user/shell-completions.md) - Setting up auto-completion
|
|
55
|
+
- [Troubleshooting](docs/user/troubleshooting.md) - Common issues and solutions
|
|
56
|
+
- [Alfred Integration](docs/user/alfred/) - macOS Alfred workflow (installation, troubleshooting)
|
|
57
|
+
|
|
58
|
+
### 👨💻 [Developer Documentation](docs/developer/) - For contributors
|
|
59
|
+
- [Contributing Guide](docs/developer/contributing.md) - How to contribute to the project
|
|
60
|
+
- [Development Guide](docs/developer/development.md) - Setup and coding guidelines
|
|
61
|
+
- [Alfred Workflow Development](docs/developer/alfred-workflow-development.md) - Building and packaging
|
|
62
|
+
- [Testing Strategy](docs/developer/testing/README.md) - Testing approach and procedures
|
|
63
|
+
|
|
64
|
+
### 📚 [Reference Documentation](docs/reference/) - For everyone
|
|
65
|
+
- [Changelogs](docs/reference/) - What changed and when
|
|
66
|
+
- [Release Process](docs/reference/releasing.md) - How releases work
|
|
67
|
+
|
|
68
|
+
See [Documentation Overview](docs/README.md) for the complete structure and classification guide.
|
|
59
69
|
|
|
60
70
|
## Testing
|
|
61
71
|
|
|
@@ -67,7 +77,7 @@ npm run test:coverage # Generate coverage report
|
|
|
67
77
|
npm run test:extract-patterns # Extract patterns from real data (requires token)
|
|
68
78
|
```
|
|
69
79
|
|
|
70
|
-
See [Testing
|
|
80
|
+
See [Testing Strategy](docs/developer/testing/README.md) for details on the hybrid testing approach.
|
|
71
81
|
|
|
72
82
|
## Usage
|
|
73
83
|
|
|
@@ -139,7 +149,7 @@ bktide annotations <build>
|
|
|
139
149
|
|
|
140
150
|
The build reference can be specified in two formats:
|
|
141
151
|
- **Slug format**: `org/pipeline/number` (e.g., `gusto/zenpayroll/1287418`)
|
|
142
|
-
- **URL format**:
|
|
152
|
+
- **URL format**: `https://buildkite.com/org/pipeline/builds/number`
|
|
143
153
|
|
|
144
154
|
Additional options:
|
|
145
155
|
```bash
|
|
@@ -165,7 +175,7 @@ View detailed information about a specific build including jobs and annotations.
|
|
|
165
175
|
bktide build org/pipeline/123
|
|
166
176
|
|
|
167
177
|
# View build by URL format
|
|
168
|
-
bktide build
|
|
178
|
+
bktide build https://buildkite.com/org/pipeline/builds/123
|
|
169
179
|
```
|
|
170
180
|
|
|
171
181
|
Additional options:
|
|
@@ -315,12 +325,12 @@ Available log levels (from most to least verbose):
|
|
|
315
325
|
|
|
316
326
|
## Log Files
|
|
317
327
|
|
|
318
|
-
All logs are written to
|
|
328
|
+
All logs are written to `~/.local/state/bktide/logs/cli.log` in JSON format, which can be processed with tools like jq:
|
|
319
329
|
|
|
320
330
|
```bash
|
|
321
331
|
# View recent errors
|
|
322
|
-
cat
|
|
332
|
+
cat ~/.local/state/bktide/logs/cli.log | grep -v '"level":30' | jq
|
|
323
333
|
|
|
324
334
|
# Analyze performance
|
|
325
|
-
cat
|
|
335
|
+
cat ~/.local/state/bktide/logs/cli.log | jq 'select(.duration != null) | {msg, duration}'
|
|
326
336
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bktide",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1765203819",
|
|
4
4
|
"description": "Command-line interface for Buildkite CI/CD workflows with rich shell completions (Fish, Bash, Zsh) and Alfred workflow integration for macOS power users",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"type": "module",
|