@devboxer/cli 0.1.21

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 (3) hide show
  1. package/README.md +157 -0
  2. package/dist/index.js +1214 -0
  3. package/package.json +72 -0
package/README.md ADDED
@@ -0,0 +1,157 @@
1
+ # DevBoxer CLI
2
+
3
+ ![](https://img.shields.io/badge/Node.js-18%2B-brightgreen?style=flat-square) [![npm]](https://www.npmjs.com/package/@devboxerhub/cli)
4
+
5
+ [npm]: https://img.shields.io/npm/v/@devboxerhub/cli.svg?style=flat-square
6
+
7
+ The official CLI for DevBoxer - your AI-powered coding assistant.
8
+
9
+ ## Installation
10
+
11
+ ```bash
12
+ # Using npm
13
+ npm install -g @devboxerhub/cli
14
+
15
+ # Using pnpm
16
+ pnpm add -g @devboxerhub/cli
17
+
18
+ # Using yarn
19
+ yarn global add @devboxerhub/cli
20
+ ```
21
+
22
+ ## Commands
23
+
24
+ ### `devboxer auth`
25
+
26
+ Authenticate with your DevBoxer account. This will:
27
+
28
+ 1. Open your browser for authentication
29
+ 2. Generate a secure token
30
+ 3. Store credentials safely in `~/.devboxer/config.json` (configurable via `DEVBOXER_SETTINGS_DIR`)
31
+ 4. Confirm successful connection
32
+
33
+ ```bash
34
+ devboxer auth
35
+ ```
36
+
37
+ #### Configuration directory
38
+
39
+ By default, credentials are stored in `~/.devboxer/config.json`. You can override the settings directory by setting the `DEVBOXER_SETTINGS_DIR` environment variable:
40
+
41
+ ```bash
42
+ # Example: use a custom settings directory
43
+ export DEVBOXER_SETTINGS_DIR=~/.config/devboxer
44
+ devboxer auth
45
+ ```
46
+
47
+ ### `devboxer create`
48
+
49
+ Create a new task in DevBoxer with a message:
50
+
51
+ ```bash
52
+ # Create a task in the current repository and branch
53
+ devboxer create "Fix the login bug"
54
+
55
+ # Specify a different repository
56
+ devboxer create "Add new feature" --repo owner/repo
57
+
58
+ # Use a specific base branch
59
+ devboxer create "Update documentation" --branch develop
60
+
61
+ # Use existing branch without creating a new one
62
+ devboxer create "Quick fix" --no-new-branch
63
+
64
+ # Start in plan mode (no file writes until approval)
65
+ devboxer create "Refactor the auth module" --mode plan
66
+
67
+ # Choose a specific model
68
+ devboxer create "Investigate flaky tests" --model sonnet
69
+ devboxer create "Run large codegen" --model gpt-5-high
70
+ > GPT-5.1 Codex Max variants require a ChatGPT subscription connected in Settings.
71
+ ```
72
+
73
+ #### Options
74
+
75
+ - `-r, --repo <repo>`: GitHub repository (default: current repository)
76
+ - `-b, --branch <branch>`: Base branch name (default: current branch, falls back to main)
77
+ - `--no-new-branch`: Don't create a new branch (default: creates new branch)
78
+ - `-m, --mode <mode>`: Task mode: `plan` or `execute` (default: `execute`)
79
+ - `-M, --model <model>`: AI model to use: `opus`, `sonnet`, `haiku`, `amp`, `gpt-5-low`, `gpt-5-medium`, `gpt-5`, `gpt-5-high`, `gpt-5.2-low`, `gpt-5.2-medium`, `gpt-5.2`, `gpt-5.2-high`, `gpt-5.1-low`, `gpt-5.1-medium`, `gpt-5.1`, `gpt-5.1-high`, `gpt-5.1-codex-max-low`, `gpt-5.1-codex-max-medium`, `gpt-5.1-codex-max`, `gpt-5.1-codex-max-high`, `gpt-5.1-codex-max-xhigh`, `gpt-5-codex-low`, `gpt-5-codex-medium`, `gpt-5-codex-high`, `gpt-5.1-codex-low`, `gpt-5.1-codex-medium`, `gpt-5.1-codex-high`, `gemini-3-pro`, `gemini-2.5-pro`, `grok-code`, `qwen3-coder`, `kimi-k2`, `glm-4.6`, `opencode/gemini-2.5-pro` (optional)
80
+
81
+ ### `devboxer pull`
82
+
83
+ Pull tasks from DevBoxer to your local machine:
84
+
85
+ ```bash
86
+ # Interactive mode - select from recent tasks
87
+ devboxer pull
88
+
89
+ # Pull a specific task by ID
90
+ devboxer pull <taskId>
91
+
92
+ # Pull and automatically launch Claude Code
93
+ devboxer pull <taskId> --resume
94
+ ```
95
+
96
+ **Getting the task ID**: You can find the task ID at the end of the URL when viewing a task in DevBoxer. For example, in `https://devboxer.com/tasks/abc123-def456`, the task ID is `abc123-def456`.
97
+
98
+ #### Options
99
+
100
+ - `-r, --resume`: Automatically launch Claude Code after pulling
101
+
102
+ ### `devboxer list`
103
+
104
+ List all tasks in a non-interactive format:
105
+
106
+ ```bash
107
+ # List all tasks (automatically filters by current repo when inside a Git repository)
108
+ devboxer list
109
+ ```
110
+
111
+ #### Example Output
112
+
113
+ ```
114
+ Task ID abc123def456
115
+ Name Fix login bug
116
+ Branch devboxer/fix-login
117
+ Repository myorg/myrepo
118
+ PR Number #123
119
+
120
+ Task ID def789ghi012
121
+ Name Add dark mode
122
+ Branch devboxer/dark-mode
123
+ Repository myorg/myrepo
124
+ PR Number N/A
125
+
126
+ Total: 2 tasks
127
+ ```
128
+
129
+ ### `devboxer mcp`
130
+
131
+ Run an MCP (Model Context Protocol) server for the git repository:
132
+
133
+ ```bash
134
+ # Run MCP server for current directory
135
+ devboxer mcp
136
+ ```
137
+
138
+ #### Claude Code Integration
139
+
140
+ You can add the DevBoxer MCP server to your local Claude Code instance to enable direct interaction with DevBoxer tasks from within Claude:
141
+
142
+ ```bash
143
+ claude mcp add devboxer -- devboxer mcp
144
+ ```
145
+
146
+ This integration provides Claude Code with the following capabilities:
147
+
148
+ - **`devboxer_list`**: List all your DevBoxer tasks directly from Claude
149
+ - **`devboxer_create`**: Create new tasks without leaving Claude Code
150
+ - **`devboxer_pull`**: Pull task session data to continue work
151
+
152
+ The MCP server acts as a bridge between Claude Code and DevBoxer, allowing you to manage tasks using natural language commands within your AI coding sessions.
153
+
154
+ ## Support
155
+
156
+ - **Documentation**: [https://docs.devboxer.com](https://docs.devboxer.com)
157
+ - **Website**: [https://devboxer.com](https://devboxer.com)