Skip to content

Commit c5a42f5

Browse files
committed
updated docs away from using amazonq in them further. In links etc.
1 parent a745a1a commit c5a42f5

File tree

6 files changed

+23
-70
lines changed

6 files changed

+23
-70
lines changed

README.md

Lines changed: 3 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,11 @@
22

33
## Installation
44

5-
- **macOS**:
6-
- **DMG**: [Download now](https://desktop-release.q.us-east-1.amazonaws.com/latest/Amazon%20Q.dmg)
7-
- **HomeBrew**: ```brew install --cask amazon-q ```
8-
- **Linux**:
9-
- [Ubuntu/Debian](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-ubuntu)
10-
- [AppImage](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-appimage)
11-
- [Alternative Linux builds](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html#command-line-installing-alternative-linux)
12-
13-
## Contributing
14-
15-
Thank you so much for considering to contribute to KIRO CLI.
16-
17-
Before getting started, see our [contributing docs](CONTRIBUTING.md#security-issue-notifications).
18-
19-
### Prerequisites
20-
21-
- MacOS
22-
- Xcode 13 or later
23-
- Brew
24-
25-
#### 1. Clone repo
26-
27-
```shell
28-
git clone https://github.com/aws/amazon-q-developer-cli.git
5+
Please use this command to install kiro.
6+
``` shell
7+
curl -fsSL https://cli.kiro.dev/install | bash
298
```
309

31-
#### 2. Install the Rust toolchain using [Rustup](https://rustup.rs):
32-
33-
```shell
34-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
35-
rustup default stable
36-
rustup toolchain install nightly
37-
cargo install typos-cli
38-
```
39-
40-
#### 3. Develop locally
41-
42-
- To compile and run: `cargo run --bin chat_cli`.
43-
- To run tests: `cargo test`.
44-
- To run lints: `cargo clippy`.
45-
- To format rust files: `cargo +nightly fmt`.
46-
- To run subcommands: `cargo run --bin chat_cli -- {subcommand}`.
47-
- Login would then be: `cargo run --bin chat_cli -- login`
48-
49-
## Project Layout
50-
51-
- [`chat_cli`](crates/chat-cli/) - the `kiro` CLI, allows users to interface with KIRO Developer from
52-
the command line
53-
- [`scripts/`](scripts/) - Contains ops and build related scripts
54-
- [`crates/`](crates/) - Contains all rust crates
55-
- [`docs/`](docs/) - Contains technical documentation
56-
5710
## Security
5811

5912
For security related concerns, see [here](SECURITY.md).

crates/chat-cli/src/cli/chat/tools/introspect.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ impl Introspect {
8181
documentation.push_str("\n\n--- changelog (from feed.json) ---\n");
8282
// Include recent changelog entries from feed.json
8383
let feed = crate::cli::feed::Feed::load();
84-
let recent_entries = feed.get_all_changelogs().into_iter().take(5).collect::<Vec<_>>();
84+
let recent_entries = feed.get_all_changelogs().into_iter().take(1).collect::<Vec<_>>();
8585
for entry in recent_entries {
8686
documentation.push_str(&format!("\n## {} ({})\n", entry.version, entry.date));
8787
for change in &entry.changes {

docs/agent-file-locations.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ Agent configuration files can be placed in two different locations, allowing for
77
Local agents are stored in the current working directory under:
88

99
```
10-
.amazonq/cli-agents/
10+
.kiro/agents/
1111
```
1212

1313
These agents are specific to the current workspace or project and are only available when running KIRO CLI from that directory or its subdirectories.
1414

1515
**Example structure:**
1616
```
1717
my-project/
18-
├── .amazonq/
19-
│ └── cli-agents/
18+
├── .kiro/
19+
│ └── agents/
2020
│ ├── dev-agent.json
2121
│ └── aws-specialist.json
2222
└── src/
@@ -28,16 +28,16 @@ my-project/
2828
Global agents are stored in your home directory under:
2929

3030
```
31-
~/.aws/amazonq/cli-agents/
31+
~/.kiro/agents/
3232
```
3333

34-
Note: For globally available agents, the `amazonq` directory is in the `.aws` folder.
34+
Note: For globally available agents, the `agents` directory is in the `.kiro` folder.
3535

3636
These agents are available from any directory when using KIRO CLI.
3737

3838
**Example structure:**
3939
```
40-
~/.aws/amazonq/cli-agents/
40+
~/.kiro/agents/
4141
├── general-assistant.json
4242
├── code-reviewer.json
4343
└── documentation-writer.json
@@ -47,8 +47,8 @@ These agents are available from any directory when using KIRO CLI.
4747

4848
When KIRO CLI looks for an agent, it follows this precedence order:
4949

50-
1. **Local first**: Checks `.amazonq/cli-agents/` in the current working directory
51-
2. **Global fallback**: If not found locally, checks `~/.aws/amazonq/cli-agents/` in the home directory
50+
1. **Local first**: Checks `.kiro/agents/` in the current working directory
51+
2. **Global fallback**: If not found locally, checks `~/.kiro/agents/` in the home directory
5252

5353
## Naming Conflicts
5454

@@ -79,8 +79,8 @@ The global agent with the same name will be ignored in favor of the local versio
7979
To create a local agent for your current project:
8080

8181
```bash
82-
mkdir -p .amazonq/cli-agents
83-
cat > .amazonq/cli-agents/project-helper.json << 'EOF'
82+
mkdir -p .kiro/agents
83+
cat > .kiro/agents/project-helper.json << 'EOF'
8484
{
8585
"description": "Helper agent for this specific project",
8686
"tools": ["fs_read", "fs_write", "execute_bash"],
@@ -95,8 +95,8 @@ EOF
9595
To create a global agent available everywhere:
9696

9797
```bash
98-
mkdir -p ~/.aws/amazonq/cli-agents
99-
cat > ~/.aws/amazonq/cli-agents/general-helper.json << 'EOF'
98+
mkdir -p ~/.kiro/agents
99+
cat > ~/.kiro/agents/general-helper.json << 'EOF'
100100
{
101101
"description": "General purpose assistant",
102102
"tools": ["*"],
@@ -107,4 +107,4 @@ EOF
107107

108108
## Directory Creation
109109

110-
KIRO CLI will automatically create the global agents directory (`~/.aws/amazonq/cli-agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.amazonq/cli-agents/`) in your workspace if you want to use local agents.
110+
KIRO CLI will automatically create the global agents directory (`~/.kiro/agents/`) if it doesn't exist. However, you need to manually create the local agents directory (`.kiro/agents/`) in your workspace if you want to use local agents.

docs/built-in-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ This tool has no configuration options.
127127

128128
## TODO List Tool (experimental)
129129

130-
Create and manage TODO lists for tracking multi-step tasks. Lists are stored locally in `.amazonq/cli-todo-lists/`.
130+
Create and manage TODO lists for tracking multi-step tasks. Lists are stored locally in `.kiro/cli-todo-lists/`.
131131

132132
This tool has no configuration options.
133133

docs/experiments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The summary is automatically added to your conversation context, so you can ask
147147
- Only one task can run per agent at a time
148148

149149
**Task Storage:**
150-
Task execution details are stored in `.amazonq/.subagents/` in your current directory. Files persist until the same agent runs a new task.
150+
Task execution details are stored in `.kiro/.subagents/` in your current directory. Files persist until the same agent runs a new task.
151151

152152
**Settings:**
153153
- `chat.enableDelegate` - Enable/disable delegate feature (boolean)
@@ -162,7 +162,7 @@ Task execution details are stored in `.amazonq/.subagents/` in your current dire
162162
**Features:**
163163
- Q will automatically make TODO lists when appropriate or when asked
164164
- View, manage, and delete TODOs using `/todos`
165-
- Resume existing TODO lists stored in `.amazonq/cli-todo-lists`
165+
- Resume existing TODO lists stored in `.kiro/cli-todo-lists`
166166

167167
**Usage:**
168168
```

docs/todo-lists.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Delete specific TODO lists or all lists at once.
3939

4040
## Storage
4141

42-
TODO lists are stored locally in `.amazonq/cli-todo-lists/` directory within your current working directory. Each list is saved as a JSON file with:
42+
TODO lists are stored locally in `.kiro/cli-todo-lists/` directory within your current working directory. Each list is saved as a JSON file with:
4343

4444
- Unique timestamp-based ID
4545
- Task descriptions and completion status
@@ -81,14 +81,14 @@ All commands use interactive selection allowing you to:
8181
If commands show "No to-do lists available":
8282

8383
1. **Check directory**: Ensure you're in the directory where lists were created
84-
2. **Verify storage**: Look for `.amazonq/cli-todo-lists/` directory
84+
2. **Verify storage**: Look for `.kiro/cli-todo-lists/` directory
8585
3. **Create lists**: Use chat sessions to create new TODO lists
8686

8787
#### Lists Not Loading
8888

8989
If lists exist but won't load:
9090

91-
1. **Check permissions**: Ensure read access to `.amazonq/cli-todo-lists/`
91+
1. **Check permissions**: Ensure read access to `.kiro/cli-todo-lists/`
9292
2. **Verify format**: Lists should be valid JSON files
9393
3. **Check file integrity**: Corrupted files may prevent loading
9494

0 commit comments

Comments
 (0)