Publish harness and TUI open-source
initial sync from the monorepo
This commit is contained in:
commit
c68e39f604
2734 changed files with 1437016 additions and 0 deletions
61
crates/codegen/xai-grok-pager/npm/grok/README.md
Normal file
61
crates/codegen/xai-grok-pager/npm/grok/README.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# Grok
|
||||
|
||||
Bring Grok into your terminal. Fast, flicker-free CLI built for plans, subagents, and parallel work.
|
||||
|
||||
**[Homepage](https://x.ai/cli)** | **[Documentation](https://docs.x.ai/build/overview)**
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
curl -fsSL https://x.ai/cli/install.sh | bash
|
||||
```
|
||||
|
||||
Or install with npm:
|
||||
|
||||
```bash
|
||||
npm i -g @xai-official/grok
|
||||
```
|
||||
|
||||
## Get Started
|
||||
|
||||
```bash
|
||||
# Launch the interactive TUI
|
||||
grok
|
||||
|
||||
# Run a single task
|
||||
grok -p "Explain this codebase"
|
||||
```
|
||||
|
||||
On first launch, Grok opens your browser to authenticate. For CI or headless environments, use an API key from [console.x.ai](https://console.x.ai):
|
||||
|
||||
```bash
|
||||
export XAI_API_KEY="xai-..."
|
||||
```
|
||||
|
||||
## Update
|
||||
|
||||
```bash
|
||||
grok update
|
||||
```
|
||||
|
||||
Or if installed via npm:
|
||||
|
||||
```bash
|
||||
npm i -g @xai-official/grok@latest
|
||||
```
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
| Platform | Architecture |
|
||||
|---|---|
|
||||
| macOS | Apple Silicon (arm64) |
|
||||
| Linux | x86_64, arm64 |
|
||||
| Windows | x86_64 |
|
||||
|
||||
## Documentation
|
||||
|
||||
For full documentation including configuration, MCP servers, custom models, headless mode, agent mode, and more, visit [docs.x.ai/build/overview](https://docs.x.ai/build/overview).
|
||||
|
||||
## Feedback
|
||||
|
||||
Run `/feedback` inside Grok to report issues or send feedback directly.
|
||||
Loading…
Reference in a new issue