llmist 1.2.0 → 1.3.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.
package/README.md CHANGED
@@ -16,7 +16,7 @@ llmist is an asynchonous, streaming-first, provider-agnostic LLM client that mak
16
16
  ## 🎯 Why llmist?
17
17
 
18
18
  - **🌍 Universal** - Works with any LLM provider (OpenAI, Anthropic, Gemini, custom)
19
- - **📝 No Structured Outputs** - Flexible TOML/YAML/JSON grammar works with any text model
19
+ - **📝 No Structured Outputs** - Simple block format with `!!!ARG:` markers works with any text model
20
20
  - **⚡ Streaming-First** - Built for real-time responses and efficient error handling
21
21
  - **🪝 Powerful Hooks** - Monitor, customize, and control every step of execution
22
22
  - **🎨 Beautiful API** - Fluent builder pattern with model shortcuts and presets
@@ -56,9 +56,6 @@ cat document.txt | llmist complete "Summarize" --model gpt-5-nano
56
56
  ```bash
57
57
  # Disable built-in gadgets
58
58
  bunx llmist agent "Task" --no-builtins -g ./my-tools.ts
59
-
60
- # Override parameter format (default: toml, options: toml, yaml, json, auto)
61
- bunx llmist agent "Task" --parameter-format yaml -g ./my-tools.ts
62
59
  ```
63
60
 
64
61
  📖 **[CLI Reference](./docs/CLI.md)** | **[CLI Gadgets Guide](./docs/CLI_GADGETS.md)**
@@ -354,6 +351,7 @@ Uses provider-specific methods (tiktoken for OpenAI, native APIs for Anthropic/G
354
351
 
355
352
  **Core Concepts**
356
353
  - **[Gadgets (Tools)](./docs/GADGETS.md)** - Creating custom functions
354
+ - **[Block Format](./docs/BLOCK_FORMAT.md)** - Parameter syntax reference
357
355
  - **[Hooks](./docs/HOOKS.md)** - Lifecycle monitoring and control
358
356
  - **[Streaming](./docs/STREAMING.md)** - Real-time response handling
359
357
  - **[Human-in-the-Loop](./docs/HUMAN_IN_LOOP.md)** - Interactive workflows
@@ -433,60 +431,7 @@ bun run format
433
431
 
434
432
  ## 🤝 Contributing
435
433
 
436
- Contributions welcome! Please ensure:
437
-
438
- 1. ✅ All tests pass: `bun test`
439
- 2. ✅ Code is formatted: `bun run format`
440
- 3. ✅ Linting passes: `bun run lint`
441
- 4. ✅ Types are properly defined
442
- 5. ✅ Examples/docs updated for API changes
443
-
444
- ### Commit Message Convention
445
-
446
- This project follows [Conventional Commits](https://www.conventionalcommits.org/) specification. All commit messages must be formatted as:
447
-
448
- ```
449
- <type>(<scope>): <subject>
450
- ```
451
-
452
- **Types:**
453
- - `feat:` - New feature (triggers minor version bump)
454
- - `fix:` - Bug fix (triggers patch version bump)
455
- - `docs:` - Documentation only changes
456
- - `style:` - Code style changes (formatting, missing semi-colons, etc)
457
- - `refactor:` - Code refactoring without feature changes
458
- - `perf:` - Performance improvements
459
- - `test:` - Adding or updating tests
460
- - `build:` - Build system or dependency changes
461
- - `ci:` - CI configuration changes
462
- - `chore:` - Other changes that don't modify src or test files
463
-
464
- **Breaking Changes:** Add `BREAKING CHANGE:` in the footer to trigger major version bump.
465
-
466
- **Examples:**
467
- ```bash
468
- feat(agent): add support for streaming tool calls
469
- fix(cli): prevent crash on invalid gadget path
470
- docs: update API documentation for v2
471
- ```
472
-
473
- **Note:** Git hooks will validate your commit messages locally.
474
-
475
- ### Release Process
476
-
477
- Releases are fully automated using [semantic-release](https://github.com/semantic-release/semantic-release):
478
-
479
- 1. Merge PR to `main` branch
480
- 2. CI workflow runs automatically
481
- 3. If CI passes, release workflow:
482
- - Analyzes commits since last release
483
- - Determines version bump based on commit types
484
- - Updates `package.json` and `CHANGELOG.md`
485
- - Creates git tag and GitHub release
486
- - Publishes to npm
487
- - Syncs changes back to `dev` branch
488
-
489
- **No manual version bumps needed!**
434
+ Contributions welcome! See **[CONTRIBUTING.md](./CONTRIBUTING.md)** for guidelines, commit conventions, and release process.
490
435
 
491
436
  ---
492
437