Skip to content

Commit

Permalink
copy
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-gauthier committed Jan 22, 2025
1 parent fceead7 commit 05a77c7
Showing 1 changed file with 57 additions and 55 deletions.
112 changes: 57 additions & 55 deletions aider/website/docs/usage/not-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ nav_order: 901
description: Use aider to edit configuration files, documentation, and other text-based formats.
---


# Editing config & text files

Aider isn't just for code, it can be very helpful when editing
Expand All @@ -15,51 +16,58 @@ or pretty much any configuration or documentation file.
Here are some practical examples of modifying common config/text files:

## Shell Configuration
```bash

<div class="chat-transcript" markdown="1">
$ aider .bashrc

Added .bashrc to the chat.
────────────────────────────────────────────────────────────────
.bashrc
> Add an alias 'll' that lists all files, with all details in human readable format. And update PATH to include uv installed tools.


#### Add an alias 'll' that lists all files, with all details in human readable format. And update PATH to include uv installed tools.

```
+ alias ll='ls -alh'
+ export PATH="$HOME/.local/bin:$PATH"
+ export PATH="$PATH:$HOME/.local/bin:$PATH"
```
</div>

## SSH Configurations
```bash

<div class="chat-transcript" markdown="1">
$ aider ~/.ssh/config

Added config to the chat.
────────────────────────────────────────────────────────────────
config
> Create a Host entry 'my-server' using bastion.example.com as JumpHost

#### Create a Host entry 'my-server' using bastion.example.com as JumpHost

```
+ Host my-server
+ HostName 192.168.1.100
+ User deploy
+ Port 2222
+ IdentityFile ~/.ssh/deploy_key
+ ProxyJump bastion.example.com
```
</div>

## Docker Setup
```bash

<div class="chat-transcript" markdown="1">
$ aider Dockerfile docker-compose.yml

Added Dockerfile and docker-compose.yml to the chat.
────────────────────────────────────────────────────────────────
Dockerfile
> Set non-root user and enable healthchecks

#### Set non-root user and enable healthchecks

```
+ USER appuser
+ HEALTHCHECK --interval=30s --timeout=3s \
+ CMD curl -f http://localhost:8000/health || exit 1
```

docker-compose.yml
> Expose port 5432 and add volume for postgres data
#### Expose port 5432 and add volume for postgres data

```
services:
postgres:
image: postgres:15
Expand All @@ -68,110 +76,104 @@ docker-compose.yml
+ volumes:
+ - pgdata:/var/lib/postgresql/data
```
</div>

## Git Configuration
```bash

<div class="chat-transcript" markdown="1">
$ aider .gitconfig

Added .gitconfig to the chat.
────────────────────────────────────────────────────────────────
.gitconfig
> Set default push behavior to current branch and enable color UI

#### Set default push behavior to current branch and enable color UI

```
+ [push]
+ default = current
+ [color]
+ ui = auto
```
</div>

## System Configuration
```bash
<div class="chat-transcript" markdown="1">
$ aider /etc/hosts # May need sudo

Added hosts to the chat.
────────────────────────────────────────────────────────────────
hosts
> Block tracking domains by pointing them to 127.0.0.1

#### Block tracking domains by pointing them to 127.0.0.1

```
+ 127.0.0.1 ads.example.com
+ 127.0.0.1 track.analytics.co
```
</div>


## Editor Configs
```bash
<div class="chat-transcript" markdown="1">
$ aider .vimrc

Added .vimrc to the chat.
────────────────────────────────────────────────────────────────
.vimrc
> Enable line numbers and set 4-space tabs for Python

#### Enable line numbers and set 4-space tabs for Python

```
+ set number
+ autocmd FileType python set tabstop=4 shiftwidth=4 expandtab
```
</div>

## Application Configuration
```bash
## VSCode Configuration
<div class="chat-transcript" markdown="1">
$ aider settings.json

Added settings.json to the chat.
────────────────────────────────────────────────────────────────
settings.json (VSCode)
> Enable auto-format on save and set default formatter

#### Enable auto-format on save and set default formatter

```
+ "editor.formatOnSave": true,
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
```

## Environment Files
```bash
$ aider .env

Added .env to the chat.
────────────────────────────────────────────────────────────────
.env
> Configure database connection with SSL

+ DB_HOST=db.example.com
+ DB_PORT=5432
+ DB_SSL=true
```
</div>

## Markdown Documentation
```bash
<div class="chat-transcript" markdown="1">
$ aider README.md

Added README.md to the chat.
────────────────────────────────────────────────────────────────
README.md
> Add installation section with brew and pip options


#### Add installation section with brew and pip options

```
+ ## Installation
+ ```bash
+ ```
+ # Homebrew
+ brew install cool-app-10k
+
+ # PyPI
+ pipx install cool-app-10k
+ ```
```
</div>

## XML Configuration
```bash
<div class="chat-transcript" markdown="1">
$ aider pom.xml

Added pom.xml to the chat.
────────────────────────────────────────────────────────────────
pom.xml
> Add JUnit 5 dependency with test scope
#### Add JUnit 5 dependency with test scope

```
+ <dependency>
+ <groupId>org.junit.jupiter</groupId>
+ <artifactId>junit-jupiter-api</artifactId>
+ <version>5.9.2</version>
+ <scope>test</scope>
+ </dependency>
```
</div>


0 comments on commit 05a77c7

Please sign in to comment.