Skip to main content
Availability
vscode

About Instructions

Augment’s Instructions let you use natural language prompts to insert new code or modify your existing code. Instructions can be initiated by hitting Cmd/Ctrl I and entering an instruction inside the input box that appears in the diff view. The change will be applied as a diff to be reviewed before accepting.

Using Instructions

To start a new Instruction, there are two options. You can select & highlight the code you want to change or place your cursor where you want new code to be added, then press Cmd/Ctrl I. You’ll be taken to a diff view where you can enter your prompt and see the results. For example, you can generate new functions based on existing code:
> Add a getUser function that takes userId as a parameter
Augment Instructions Diff Your change will be made as a diff, so you can review the suggested updates before modifying your code. Use the following shortcuts or click the options in the UI to accept or reject the changes.
  • MacOS
  • Windows/Linux
ActionShortcut
Start instructionCmd I
AcceptReturn
RejectEsc
I