Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# EditorConfig helps maintain consistent coding styles
# across different editors and IDEs
# https://editorconfig.org

root = true

# All files
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

# TypeScript and JavaScript
[*.{ts,tsx,js,jsx}]
indent_size = 2
quote_type = single

# JSON
[*.json]
indent_size = 2

# YAML
[*.{yml,yaml}]
indent_size = 2

# Markdown
[*.md]
trim_trailing_whitespace = false
max_line_length = off

# Shell scripts
[*.sh]
indent_size = 2

# Package files
[package.json]
indent_size = 2

# Makefiles
[Makefile]
indent_style = tab

# Git config files
[.gitconfig]
indent_style = tab

# Windows batch files
[*.{cmd,bat}]
end_of_line = crlf
28 changes: 25 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Grok API Configuration
# Grok CLI Environment Variables
# Copy this file to .env and fill in your values
# Get your API key from https://x.ai

# API Key (required)
GROK_API_KEY=your_grok_api_key_here

# Optional: Custom Grok API Base URL
# GROK_BASE_URL=https://api.x.ai/v1
# Alternative API key name (for compatibility)
# XAI_API_KEY=your_api_key_here

# Base URL (optional)
# Default: https://api.x.ai/v1
# Use custom endpoints for proxies or different providers
# GROK_BASE_URL=https://api.x.ai/v1

# Default Model (optional)
# Options: grok-beta, grok-2-1212, grok-3-latest, grok-4-latest
# Default: grok-4-latest
# GROK_MODEL=grok-4-latest

# Performance Monitoring (optional)
# Enable performance tracking
# GROK_PERFORMANCE_MONITORING=false

# Debug Mode (optional)
# Enable debug logging
# GROK_DEBUG=false
20 changes: 20 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Funding options for Grok CLI
# These are supported funding model platforms

# GitHub Sponsors
# github: [username]

# Open Collective
# open_collective: grok-cli

# Ko-fi
# ko_fi: username

# Patreon
# patreon: username

# Buy Me a Coffee
# custom: ['https://www.buymeacoffee.com/username']

# Uncomment and add your funding platforms above
# Remove this file if you don't want to accept sponsorships
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
name: Bug Report
about: Report a bug to help us improve
title: '[BUG] '
labels: bug
assignees: ''

---

## Bug Description

A clear and concise description of what the bug is.

## To Reproduce

Steps to reproduce the behavior:
1. Run command '...'
2. Enter input '...'
3. Observe error '...'

## Expected Behavior

A clear and concise description of what you expected to happen.

## Actual Behavior

A clear and concise description of what actually happened.

## Environment

- **Grok CLI version**: [e.g., 0.0.12] (run `grok --version`)
- **Node.js version**: [e.g., 18.0.0] (run `node --version`)
- **npm version**: [e.g., 9.0.0] (run `npm --version`)
- **Operating System**: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11]
- **Shell**: [e.g., bash, zsh, powershell]

## Logs and Screenshots

<details>
<summary>Error logs (if applicable)</summary>

```
Paste error logs here
```

</details>

If applicable, add screenshots to help explain your problem.

## Additional Context

Add any other context about the problem here.

## Possible Solution

If you have any ideas on how to solve this issue, please share them here.

## Checklist

- [ ] I have searched for similar issues before creating this one
- [ ] I have provided all the required information above
- [ ] I am using the latest version of Grok CLI
- [ ] I have included error logs or screenshots where relevant
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Feature Request
about: Suggest a new feature or enhancement
title: '[FEATURE] '
labels: enhancement
assignees: ''

---

## Feature Description

A clear and concise description of the feature you'd like to see.

## Problem or Use Case

Is your feature request related to a problem? Please describe.

**Example**: I'm always frustrated when [...]

## Proposed Solution

Describe the solution you'd like to see implemented.

## Alternatives Considered

Describe any alternative solutions or features you've considered.

## Examples

If possible, provide examples of how this feature would be used:

```bash
# Example command or usage
grok --new-feature "example"
```

## Benefits

Explain how this feature would benefit users:

- Benefit 1
- Benefit 2
- Benefit 3

## Implementation Ideas

If you have ideas on how this could be implemented, share them here (optional).

## Additional Context

Add any other context, screenshots, or mockups about the feature request here.

## Checklist

- [ ] I have searched for similar feature requests before creating this one
- [ ] I have described the use case clearly
- [ ] I have provided examples of how this feature would be used
- [ ] This feature aligns with the project's goals
54 changes: 54 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
version: 2
updates:
# Enable version updates for npm
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
time: "09:00"
open-pull-requests-limit: 10
reviewers:
- "vibe-kit/maintainers"
assignees:
- "vibe-kit/maintainers"
labels:
- "dependencies"
- "automated"
commit-message:
prefix: "chore"
include: "scope"
# Group all patch updates together
groups:
patch-updates:
patterns:
- "*"
update-types:
- "patch"
minor-updates:
patterns:
- "*"
update-types:
- "minor"
# Separate security updates
versioning-strategy: increase
# Ignore specific dependencies if needed
ignore:
# Example: ignore major version updates for stable deps
# - dependency-name: "some-package"
# update-types: ["version-update:semver-major"]

# Enable version updates for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
open-pull-requests-limit: 5
labels:
- "dependencies"
- "github-actions"
- "automated"
commit-message:
prefix: "chore"
include: "scope"
55 changes: 50 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,55 @@
## What does this PR do?
## Description

Describe your changes here.
<!-- Provide a brief description of the changes in this PR -->

Fixes #
## Type of Change

<!-- Mark the relevant option with an "x" -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement

## Related Issues

Closes #(issue number)

## Changes Made

- Change 1
- Change 2

## Testing

**How tested:**
- [ ] Unit tests
- [ ] Manual testing

**Test environment:**
- Node.js version:
- OS:

## Checklist

- [ ] I tested my changes
- [ ] I reviewed my own code
### Code Quality
- [ ] My code follows the style guidelines
- [ ] I have performed a self-review
- [ ] I have commented hard-to-understand areas
- [ ] No new warnings or errors
- [ ] Ran `npm run lint` successfully
- [ ] Ran `npm run typecheck` successfully

### Testing
- [ ] Added tests for new features/fixes
- [ ] All tests pass (`npm test`)
- [ ] Updated documentation

### Documentation
- [ ] Updated README.md (if needed)
- [ ] Updated CHANGELOG.md
- [ ] Added JSDoc comments

**By submitting this PR, I confirm my contribution is made under the MIT License.**
Loading