aws-samples / aws-samples/sample-autonomous-cloud-coding-agents

UX: Refactor onboarding into a single post-deploy setup command

Ouverte
#17 5 commentaires 2 réactions 0 personnes assignées Voir sur GitHub
cli documentation tooling
Langage dominant
TypeScript
Étoiles
146
Forks
46
Merge moyen
3 j 10 h
PR mergées (30 j)
24

Description

Getting from "I cloned the repo" to "I submitted my first task" is honestly painful. I had to follow 4 different doc pages in the right order, bounce between REST and CLI without knowing which to use, manually copy stack outputs, run a dozen AWS CLI commands to wire up Cognito and Secrets Manager, and keep track of 6+ values across terminal sessions. I kept a notepad open just to track ARNs and IDs.

The current flow is roughly:

1. **Installation** - prereqs, `mise run install`, `mise run build`. This part is fine.
2. **Repo preparation** - fork a test repo, edit `agent.ts` to add a Blueprint, create a GitHub PAT, bootstrap, deploy (~10 min), then retrieve 4 stack outputs with a long `aws cloudformation` command.
3. **Authentication** - store the PAT in Secrets Manager, create a Cognito user with `admin-create-user` + `admin-set-user-password` (password rules you discover by trial and error), smoke test with a manual `initiate-auth` + curl.
4. **CLI setup** - build the CLI, run `bgagent configure` with the 4 values from step 2, `bgagent login`, finally submit.

That's ~25 manual steps. If you miss one or get the region wrong, you get errors that you have no idea. Someone evaluating the project will hit this wall before they ever see the agent do anything.

## Ideal flow

```bash
mise run install && mise run build # 1. Install
mise run //cdk:deploy # 2. Deploy
mise run setup # 3. One command: prompts for PAT, email,
# password. Reads stack outputs, stores
# secret, creates user, configures CLI.
bgagent submit --repo fork/repo --issue 42 # 4. Go
```

## Possible approaches

- **`mise run setup` script** that reads stack outputs, prompts for PAT/credentials, stores the secret, creates the Cognito user, configures the CLI, and runs a smoke test. Simplest to build.
- **`bgagent setup` command** doing the same from the CLI itself. Nicer UX but more work.
- **At minimum**, merge the 4 doc pages into one linear "Getting Started" guide and recommend CLI as the default path.

### Acknowledgements

- [x] I may be able to implement this feature
- [ ] This might be a breaking change

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par lire la documentation actuelle d’installation et de Getting Started, le flux de préparation de `agent.ts` et les points d’entrée derrière `mise run //cdk:deploy`, `bgagent configure` et `bgagent login`. Définissez quelle approche implémenter avant de relier les sorties du déploiement, les identifiants PAT et Cognito, Secrets Manager, la configuration de la CLI et le smoke test en un seul flux de configuration ; le travail est considéré comme terminé lorsque la séquence documentée installation/déploiement/configuration/soumission fonctionne sans copie manuelle de valeurs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
aws, github, typescript
Domaine
authentication, cli, cloud, developer-experience
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.