@hkgdevx/logcoz 0.1.0 → 0.1.1

package/LICENSE

@@ -1,24 +1,24 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -64,16 +64,18 @@ After installation, use either:
 
 ## Quick Start
 
-Analyze a log file:
+Analyze a realistic Redis connection failure:
 
-```bash
-logcozcli explain ./app.log
+```text
+2026-03-19T10:10:00Z ERROR Error: connect ECONNREFUSED 127.0.0.1:6379
+[ioredis] Unhandled error event
+service=api requestId=redis-123
 ```
 
-Use the compatibility alias:
+Run:
 
 ```bash
-logcoz explain ./app.log
+logcozcli explain ./app.log
 ```
 
 Analyze with context and confidence reasoning:
@@ -82,10 +84,10 @@ Analyze with context and confidence reasoning:
 logcozcli explain ./app.log --context .env,docker-compose.yml,k8s.yaml --include-reasoning
 ```
 
-Enable mock LLM enhancement:
+Emit structured JSON:
 
 ```bash
-logcozcli explain ./app.log --llm --llm-provider mock
+logcozcli explain ./app.log --json
 ```
 
 Enable the OpenAI provider:
@@ -94,20 +96,8 @@ Enable the OpenAI provider:
 OPENAI_API_KEY=YOUR_API_KEY logcozcli explain ./app.log --llm --llm-provider openai --llm-model gpt-5-mini
 ```
 
-Emit structured JSON:
-
-```bash
-logcozcli explain ./app.log --json
-```
-
 Correlate multiple logs:
 
-```bash
-logcozcli correlate ./api.log ./worker.log ./nginx.log
-```
-
-Correlate as JSON:
-
 ```bash
 logcozcli correlate ./api.log ./worker.log ./nginx.log --json
 ```
@@ -191,11 +181,32 @@ OpenAI configuration:
 
 If the OpenAI provider is misconfigured or returns unusable output, LogCoz CLI falls back to the deterministic explanation and appends a warning instead of failing the command.
 
+## Troubleshooting
+
+### `OPENAI_API_KEY` is missing
+
+If you select `--llm-provider openai` without a valid API key, the command still succeeds and returns the base explanation with a warning.
+
+### Provider fallback behavior
+
+LLM providers are optional enhancements. The rule-based explanation path remains the default and fallback behavior.
+
+### Empty correlation results
+
+`correlate --json` returns a success envelope with `count: 0` and an empty `incidents` array if no shared identifiers are found.
+
+### `logcozcli` vs `logcoz`
+
+Both commands work. `logcozcli` is the primary documented binary, and `logcoz` is kept as a compatibility alias.
+
 ## Publishing
 
 The package is intended for public npm publishing.
 
-Release notes and versioning are managed with Changesets, and the primary release workflow publishes from GitHub Actions using an npm token secret.
+Release notes and versioning are managed with Changesets, and the primary release workflow publishes from GitHub Actions using:
+
+- `GITHUB_TOKEN`
+- `NPM_TOKEN`
 
 Before the first public release, verify the target version is still free on npm:
 
@@ -205,6 +216,15 @@ npm view @hkgdevx/logcoz version --registry https://registry.npmjs.org
 
 At the time of this repo update, the public registry returned `404` for `@hkgdevx/logcoz`, so `0.1.0` is available unless something is published later.
 
+Pre-publish smoke check:
+
+```bash
+pnpm check
+pnpm build
+npm pack --dry-run
+pnpm publish --dry-run --no-git-checks --access public --registry https://registry.npmjs.org
+```
+
 ## Cross-Platform Notes
 
 LogCoz CLI targets Node.js 20+ and supports Linux and Windows.

package/dist/cli.js

@@ -4,7 +4,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@hkgdevx/logcoz",
-  version: "0.1.0",
+  version: "0.1.1",
   description: "LogCoz is an intelligent CLI for analyzing application and infrastructure logs. It extracts meaningful signals, detects common failure patterns, and provides root-cause explanations with actionable debugging steps \u2014 enhanced by optional context from your environment and configuration.",
   license: "MIT",
   author: {
@@ -31,6 +31,8 @@ var package_default = {
   scripts: {
     dev: "tsx src/cli.ts",
     build: "tsup",
+    prepack: "pnpm build",
+    "release:publish": "node ./scripts/release-publish.mjs",
     typecheck: "tsc --noEmit",
     lint: "eslint .",
     "lint:fix": "eslint . --fix",