# deepseek-cli

**Repository Path**: stephenxi2023/deepseek-cli

## Basic Information

- **Project Name**: deepseek-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-02
- **Last Updated**: 2025-07-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DeepSeek CLI
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![npm version](https://badge.fury.io/js/run-deepseek-cli.svg)](https://www.npmjs.com/package/run-deepseek-cli)
[![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)

![image](https://github.com/user-attachments/assets/5686866b-a841-4303-b7c4-c2c437816644)


This repository contains the DeepSeek CLI, a command-line AI coding assistant that leverages the powerful DeepSeek Coder models to accelerate your development workflows and enhance your coding experience.

With the DeepSeek CLI you can:

- **Code Completion & Generation**: Get intelligent code suggestions and generate complete functions across 100+ programming languages.
- **Repository-Level Understanding**: Analyze and work with large codebases using DeepSeek's advanced code comprehension capabilities.
- **Code Refactoring & Migration**: Modernize legacy code, migrate between frameworks, and implement best practices.
- **Debugging & Code Review**: Get help identifying bugs, security issues, and code quality improvements.
- **Project Scaffolding**: Generate new applications, components, and boilerplate code from descriptions or requirements.
- **Multi-Language Support**: Work seamlessly across Python, JavaScript, Java, C++, Go, Rust, and 90+ other languages.

## Quickstart

1. **Prerequisites:** Ensure you have [Node.js version 18](https://nodejs.org/en/download) or higher installed.

2. **Install the CLI:** Install globally using npm:

   ```bash
   npm install -g deepseek-cli
   deepseek
   ```

   Or run directly without installation:

   ```bash
   npx deepseek-cli
   ```

3. **Configure API Access:** Set up your DeepSeek API key:

   ```bash
   export DEEPSEEK_API_KEY="your_api_key_here"
   ```

   Get your API key from [DeepSeek Platform](https://platform.deepseek.com/api_keys).

4. **Choose Your Model:** The CLI supports multiple DeepSeek Coder models:
   - `deepseek-coder-33b-instruct` (Recommended for complex tasks)
   - `deepseek-coder-6.7b-instruct` (Faster responses)
   - `deepseek-coder-1.3b-instruct` (Lightweight option)

You are now ready to use the DeepSeek CLI!

## Examples

Once the CLI is running, you can start interacting with DeepSeek Coder from your shell.

### Start a New Project

```sh
cd new-project/
deepseek
> Create a FastAPI web application with user authentication and a PostgreSQL database
```

### Work with Existing Code

```sh
git clone https://github.com/your-repo/existing-project
cd existing-project
deepseek
> Analyze this codebase and suggest performance optimizations
```

### Code Completion and Generation

```sh
deepseek
> Write a Python function to implement binary search with proper error handling
```

```sh
deepseek
> Convert this JavaScript function to TypeScript with proper type annotations
```

## Popular Tasks

### Explore and Understand Code

Start by `cd`ing into an existing or newly-cloned repository and running `deepseek`.

```text
> Explain the architecture of this application and identify the main components.
```

```text
> What design patterns are used in this codebase?
```

```text
> Find potential security vulnerabilities in this code.
```

### Code Generation and Refactoring

```text
> Implement a REST API for user management with CRUD operations.
```

```text
> Refactor this class to follow SOLID principles.
```

```text
> Add comprehensive error handling to this module.
```

### Migration and Modernization

```text
> Help me migrate this React class component to hooks.
```

```text
> Convert this Python 2.7 code to Python 3.10 with type hints.
```

```text
> Upgrade this Express.js app to use async/await instead of callbacks.
```

### Code Review and Quality

```text
> Review this pull request and suggest improvements.
```

```text
> Add unit tests for all functions in this file.
```

```text
> Optimize this algorithm for better time complexity.
```

### Project Setup

```text
> Create a React TypeScript project with Redux Toolkit and Material-UI.
```

```text
> Set up a Django project with Docker, PostgreSQL, and Redis.
```

```text
> Generate a microservices architecture using Node.js and Docker Compose.
```

## Configuration

### Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| `DEEPSEEK_API_KEY` | Your DeepSeek API key | Required |
| `DEEPSEEK_MODEL` | Model to use | `deepseek-coder-33b-instruct` |
| `DEEPSEEK_BASE_URL` | API base URL | `https://api.deepseek.com` |
| `DEEPSEEK_MAX_TOKENS` | Maximum tokens per response | `4096` |
| `DEEPSEEK_TEMPERATURE` | Response creativity (0.0-1.0) | `0.1` |

### Configuration File

Create a `.deepseek-cli.json` file in your project root or home directory:

```json
{
  "model": "deepseek-coder-6.7b-instruct",
  "temperature": 0.1,
  "maxTokens": 2048,
  "includeSystemPrompt": true,
  "autoSave": true,
  "outputFormat": "markdown"
}
```

## Supported Programming Languages

DeepSeek CLI supports intelligent code generation and completion for 100+ programming languages including:

**Popular Languages:**
`Python`, `JavaScript`, `TypeScript`, `Java`, `C++`, `C#`, `Go`, `Rust`, `PHP`, `Ruby`, `Kotlin`, `Swift`, `Scala`, `R`, `Julia`, `Dart`, `HTML`, `CSS`, `SQL`

**Systems & Scripting:**
`Shell`, `PowerShell`, `Bash`, `Dockerfile`, `Makefile`, `YAML`, `JSON`, `XML`

**Specialized:**
`CUDA`, `Assembly`, `Verilog`, `VHDL`, `Solidity`, `Protocol Buffer`, `Thrift`

For the complete list, see [Supported Languages](./docs/supported-languages.md).

## CLI Commands

| Command | Description |
|---------|-------------|
| `deepseek` | Start interactive mode |
| `deepseek --help` | Show help information |
| `deepseek --version` | Show version |
| `deepseek chat "prompt"` | Single prompt mode |
| `deepseek complete <file>` | Code completion for file |
| `deepseek review <file>` | Code review |
| `deepseek explain <file>` | Explain code |
| `deepseek test <file>` | Generate tests |
| `deepseek docs <file>` | Generate documentation |

### Interactive Mode

The interactive mode provides a rich REPL experience:

- **Syntax Highlighting**: Color-coded responses for better readability
- **Code Block Detection**: Automatic language detection and formatting
- **Session History**: Navigate through previous commands
- **File Context**: Automatic inclusion of relevant project files
- **Multi-turn Conversations**: Maintain context across interactions

## Advanced Features

### Repository Context

DeepSeek CLI automatically analyzes your repository structure and includes relevant context:

```bash
# Analyze entire repository
deepseek --include-all
> Suggest improvements for the overall code architecture

# Include specific files/directories
deepseek --include src/ tests/ README.md
> Update the documentation to reflect recent API changes
```

### Code Templates

Generate common patterns and boilerplate:

```text
> Generate a React component template with props validation
> Create a Python class with proper docstrings and type hints
> Set up a GitHub Actions workflow for CI/CD
```

### Integration Workflows

```text
> Analyze the git diff and write a commit message
> Generate API documentation from this OpenAPI spec
> Create database migration scripts from these model changes
```

## Installation Options

### NPM (Recommended)

```bash
npm install -g deepseek-cli
```

### Development Installation

```bash
git clone https://github.com/your-username/deepseek-cli.git
cd deepseek-cli
npm install
npm run build
npm link
```

### Docker

```bash
docker run -it -v $(pwd):/workspace -e DEEPSEEK_API_KEY=your_key deepseek/cli
```

## Contributing

We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.

### Development Setup

1. Fork and clone the repository
2. Install dependencies: `npm install`
3. Run tests: `npm test`
4. Start development server: `npm run dev`

### Building from Source

```bash
npm run build
npm run package
```

## Documentation

- [Full Documentation](./docs/index.md)
- [API Reference](./docs/api.md)
- [Configuration Guide](./docs/configuration.md)
- [Troubleshooting](./docs/troubleshooting.md)
- [Examples & Tutorials](./docs/examples.md)

## Performance & Limits

| Model | Speed | Context Window | Best For |
|-------|-------|----------------|----------|
| deepseek-coder-1.3b-instruct | Fastest | 16K tokens | Quick completions |
| deepseek-coder-6.7b-instruct | Fast | 16K tokens | General coding tasks |
| deepseek-coder-33b-instruct | Slower | 16K tokens | Complex analysis |

## DeepSeek Models

This project leverages the DeepSeek Coder models:

- **DeepSeek Coder Base**: Pre-trained on 2T tokens (87% code, 13% natural language)
- **DeepSeek Coder Instruct**: Fine-tuned for instruction following and chat
- **Multi-size Options**: 1.3B, 6.7B, and 33B parameter models available

For more details about the models, visit the [DeepSeek Coder GitHub repository](https://github.com/deepseek-ai/deepseek-coder).

## Troubleshooting

### Common Issues

**API Key Issues:**
```bash
export DEEPSEEK_API_KEY="your_actual_api_key"
# Verify with: echo $DEEPSEEK_API_KEY
```

**Node.js Version:**
```bash
node --version  # Should be 18+
npm update -g deepseek-cli
```

**Permission Errors:**
```bash
sudo npm install -g deepseek-cli
# Or use a Node version manager like nvm
```

For more troubleshooting help, see our [Troubleshooting Guide](./docs/troubleshooting.md).

## License

This project is licensed under the MIT License. See [LICENSE](./LICENSE) for details.

The use of DeepSeek Coder models is subject to the [DeepSeek Model License](https://github.com/deepseek-ai/deepseek-coder/blob/main/LICENSE-MODEL).

## Citation

If you use this tool in your research or projects, please cite:

```bibtex
@misc{deepseek-cli,
  title={DeepSeek CLI: Command-Line AI Coding Assistant},
  author={Your Name},
  year={2025},
  url={https://github.com/your-username/deepseek-cli}
}

@misc{deepseek-coder,
  author={Daya Guo, Qihao Zhu, Dejian Yang, Zhenda Xie, Kai Dong, Wentao Zhang, Guanting Chen, Xiao Bi, Y. Wu, Y.K. Li, Fuli Luo, Yingfei Xiong, Wenfeng Liang},
  title={DeepSeek-Coder: When the Large Language Model Meets Programming -- The Rise of Code Intelligence},
  journal={CoRR},
  volume={abs/2401.14196},
  year={2024},
  url={https://arxiv.org/abs/2401.14196}
}
```

## Contact & Support

- **Issues**: [GitHub Issues](https://github.com/holasoymalva/deepseek-cli/issues)
- **Discussions**: [GitHub Discussions](https://github.com/holasoymalva/deepseek-cli/discussions)
- **DeepSeek Support**: service@deepseek.com

## Acknowledgments

- Built on the foundation of [Gemini CLI](https://github.com/google-gemini/gemini-cli)
- Powered by [DeepSeek Coder](https://github.com/deepseek-ai/deepseek-coder) models
- Thanks to the open-source community for contributions and feedback