Skip to content

Update README to use 'deepseek-cli' instead of 'deepseek' #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RyanB28 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to use 'deepseek-cli' instead of 'deepseek' #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ With the DeepSeek CLI you can:

5. **Start Using:**
```bash
deepseek
deepseek-cli
```

### ☁️ Cloud Setup (Requires API Key)
Expand All @@ -73,7 +73,7 @@ With the DeepSeek CLI you can:

3. **Start Using:**
```bash
deepseek
deepseek-cli
```

## Examples
Expand All @@ -84,7 +84,7 @@ Once the CLI is running, you can start interacting with DeepSeek Coder from your

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

Expand All @@ -93,27 +93,27 @@ deepseek
```sh
git clone https://github.com/your-repo/existing-project
cd existing-project
deepseek
deepseek-cli
> Analyze this codebase and suggest performance optimizations
```

### Code Completion and Generation

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

```sh
deepseek
deepseek-cli
> 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`.
Start by `cd`ing into an existing or newly-cloned repository and running `deepseek-cli`.

```text
> Explain the architecture of this application and identify the main components.
Expand Down Expand Up @@ -236,20 +236,20 @@ For the complete list, see [Supported Languages](./docs/supported-languages.md).

| Command | Description |
|---------|-------------|
| `deepseek` | Start interactive mode |
| `deepseek setup` | Setup local Ollama environment |
| `deepseek chat "prompt"` | Single prompt mode |
| `deepseek --local` | Force local mode |
| `deepseek --model <model>` | Specify model to use |
| `deepseek --help` | Show help information |
| `deepseek --version` | Show version |
| `deepseek-cli` | Start interactive mode |
| `deepseek-cli setup` | Setup local Ollama environment |
| `deepseek-cli chat "prompt"` | Single prompt mode |
| `deepseek-cli --local` | Force local mode |
| `deepseek-cli --model <model>` | Specify model to use |
| `deepseek-cli --help` | Show help information |
| `deepseek-cli --version` | Show version |

### Setup Command

The setup command helps you install and configure the local environment:

```bash
deepseek setup
deepseek-cli setup
```

This will:
Expand All @@ -276,11 +276,11 @@ DeepSeek CLI automatically analyzes your repository structure and includes relev

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

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

Expand Down