@hasna/codewith 0.1.29 → 0.1.30

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 (2) hide show
  1. package/README.md +76 -4
  2. package/package.json +2 -7
package/README.md CHANGED
@@ -44,11 +44,83 @@ Run `codewith` and select **Sign in with ChatGPT**. We recommend signing into yo
44
44
 
45
45
  You can also use Codewith with an API key.
46
46
 
47
+ ## Features
48
+
49
+ ### Interactive Terminal UI
50
+
51
+ Codewith provides a rich terminal-based interface with:
52
+
53
+ - **Slash commands**: Use `/` to access commands like `/model`, `/profile`, `/config`, `/review`, and `/diff`
54
+ - **Session management**: Resume, fork, and archive previous conversations
55
+ - **Markdown rendering**: Display code, diffs, tables, and model responses in the terminal
56
+ - **Vim mode**: Optional Vim-style editing for the composer
57
+ - **Custom keybindings**: Remap TUI shortcuts to your preference
58
+ - **Theme selection**: Choose from multiple syntax highlighting themes
59
+
60
+ ### Authentication Profiles
61
+
62
+ Save and switch between multiple local authentication profiles:
63
+
64
+ ```shell
65
+ codewith login --auth-profile work
66
+ codewith login --auth-profile personal
67
+ codewith profile list
68
+ codewith --auth-profile work
69
+ ```
70
+
71
+ ### Execution Modes
72
+
73
+ - **Interactive mode**: Run `codewith` for the full TUI experience
74
+ - **Exec mode**: Run `codewith exec "your prompt"` for non-interactive tasks
75
+ - **Review mode**: Run `codewith review` for code review assistance
76
+ - **Apply mode**: Run `codewith apply` to apply diffs from previous sessions
77
+
78
+ ### Sandbox Security
79
+
80
+ Codewith can run commands under platform-specific sandboxing:
81
+
82
+ - **macOS**: Uses Seatbelt sandboxing
83
+ - **Linux**: Uses Landlock and bubblewrap (bwrap) sandboxing
84
+ - **Windows**: Uses Windows sandbox with private desktop
85
+
86
+ ### MCP (Model Context Protocol) Integration
87
+
88
+ Extend Codewith with external tools via MCP servers:
89
+
90
+ ```shell
91
+ codewith mcp list
92
+ codewith mcp add <server-name>
93
+ ```
94
+
95
+ ### Skills System
96
+
97
+ Enhance Codewith's capabilities with reusable skill definitions:
98
+
99
+ - Create `.codewith/CODEWITH.md` for project-specific instructions
100
+ - Install and manage skills through configured skill sources
101
+ - Use `/skills` to browse and manage available skills
102
+
103
+ ### Session Tools
104
+
105
+ Use built-in session tools while working:
106
+
107
+ - `/plan` switches to planning mode
108
+ - `/goal` tracks long-running objectives
109
+ - `/loop`, `/schedule`, and `/monitor` manage recurring work and lightweight monitors
110
+ - `/agent` and `/side` organize parallel or side conversations
111
+
47
112
  ## Docs
48
113
 
49
- - [**Authentication**](./docs/authentication.md)
50
- - [**Contributing**](./docs/contributing.md)
51
- - [**Installing & building**](./docs/install.md)
52
- - [**Open source fund**](./docs/open-source-fund.md)
114
+ - [**Authentication**](./docs/authentication.md) - Auth profiles, login methods, and credential management
115
+ - [**Configuration**](./docs/config.md) - Config files, settings, and customization
116
+ - [**Contributing**](./docs/contributing.md) - Development setup and contribution guidelines
117
+ - [**Getting started**](./docs/getting-started.md) - First-run workflow and common commands
118
+ - [**Slash Commands**](./docs/slash_commands.md) - TUI command reference
119
+ - [**Sandbox & Security**](./docs/sandbox.md) - Security model and sandbox configuration
120
+ - [**Installing & building**](./docs/install.md) - Installation methods and building from source
121
+ - [**Skills**](./docs/skills.md) - Creating and using Codewith skills
122
+ - [**Open source fund**](./docs/open-source-fund.md) - Open source licensing and attribution
123
+
124
+ ## License
53
125
 
54
126
  This repository is licensed under the [Apache-2.0 License](LICENSE). See [NOTICE](NOTICE), [MODIFICATIONS.md](MODIFICATIONS.md), and [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for attribution, modification, and bundled third-party notices. The Apache-2.0 license covers this codebase; it does not grant rights to OpenAI trademarks, services, accounts, subscriptions, models, or APIs.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hasna/codewith",
3
- "version": "0.1.29",
3
+ "version": "0.1.30",
4
4
  "description": "Codewith command-line coding agent from Hasna.",
5
5
  "license": "Apache-2.0",
6
6
  "bin": {
@@ -29,11 +29,6 @@
29
29
  },
30
30
  "packageManager": "pnpm@10.33.0+sha512.10568bb4a6afb58c9eb3630da90cc9516417abebd3fabbe6739f0ae795728da1491e9db5a544c76ad8eb7570f5c4bb3d6c637b2cb41bfdcdb47fa823c8649319",
31
31
  "optionalDependencies": {
32
- "@hasna/codewith-linux-x64": "0.1.29",
33
- "@hasna/codewith-linux-arm64": "0.1.29",
34
- "@hasna/codewith-darwin-x64": "0.1.29",
35
- "@hasna/codewith-darwin-arm64": "0.1.29",
36
- "@hasna/codewith-win32-x64": "0.1.29",
37
- "@hasna/codewith-win32-arm64": "0.1.29"
32
+ "@hasna/codewith-linux-arm64": "0.1.30"
38
33
  }
39
34
  }