simplify project conventions template
This commit is contained in:
1 parent
e34a532a18
commit
2fa77e3ef7
2 files changed
+24
-8
No files matched your search
@@ -175,17 +175,30 @@ ensure_project_conventions() {
|
||||
cat > "$file" <<EOF
|
||||
# AutoDL Remote Conventions
|
||||
|
||||
This file is created locally by \`autodl-remote\` to record project-level remote workflow notes.
|
||||
This file is created locally by \`autodl-remote\` to record project-specific remote workflow conventions.
|
||||
|
||||
## Runtime
|
||||
|
||||
- Activate command: \`<fill me, e.g. conda activate env or source .venv/bin/activate>\`
|
||||
- Python command: \`python\`
|
||||
- Install packages: ask before installing
|
||||
|
||||
## Remote Paths
|
||||
|
||||
- Account: \`$ACCOUNT_NAME\`
|
||||
- Remote root: \`$REMOTE_ROOT\`
|
||||
- Model directory: \`$PROJECT_MODEL_DIR\`
|
||||
- Large files such as models, datasets, checkpoints, and training outputs should stay remote unless explicitly pulled.
|
||||
- Edit code locally, upload selected files with \`put\` or \`sync-up\`, run on the remote GPU, then inspect logs/results remotely first.
|
||||
- Model dir: \`$PROJECT_MODEL_DIR\`
|
||||
- Data dir: \`<fill me>\`
|
||||
- Output dir: \`<fill me>\`
|
||||
|
||||
## Project Notes
|
||||
## Sync Rules
|
||||
|
||||
- Add project-specific paths, model locations, dataset locations, and run commands here.
|
||||
- Edit code locally first, then upload selected files.
|
||||
- Do not download models, datasets, checkpoints, or large outputs unless explicitly asked.
|
||||
- Prefer remote \`cat\`, \`tail\`, \`ls\`, and \`tree\` before downloading files.
|
||||
|
||||
## Notes
|
||||
|
||||
- Add project-specific notes here.
|
||||
EOF
|
||||
}
|
||||
|
||||
|
||||
@@ -17,6 +17,9 @@ Use this skill when the user wants Codex to work locally while controlling AutoD
|
||||
- Prefer reading remote files/logs in place with `cat`, `tail`, `ls`, and `tree`.
|
||||
- Use detached job commands for long training runs instead of manually guessing process state.
|
||||
- Use `shutdown` when the user asks to stop the remote machine; treat SSH disconnect during shutdown as likely success.
|
||||
- Before using AutoDL Remote in a project, read `.autodl-remote/CONVENTIONS.md` if it exists. Treat it as the project-specific source for runtime, paths, sync rules, and notes.
|
||||
- When the user and Codex discuss or decide any project-specific remote configuration, runtime environment, path convention, model/data/output location, sync preference, or safety rule, update `.autodl-remote/CONVENTIONS.md` so future sessions can reuse it.
|
||||
- Keep `.autodl-remote/CONVENTIONS.md` concise and project-specific; do not turn it into a generic manual.
|
||||
|
||||
## Setup
|
||||
|
||||
@@ -73,6 +76,6 @@ autodl-remote shutdown
|
||||
- Prefer `job status <name>` and `job tail <name>` for detached jobs created with `--name`.
|
||||
- Prefer `exec --script` or `exec --stdin` for complex multi-line commands, Python heredocs, env vars, JSON, awk, or sed.
|
||||
- Use `put-run` when the workflow is "upload these local paths, then immediately run this remote command".
|
||||
- `model-dir` prints the project model directory convention. The first project command creates `.autodl-remote/CONVENTIONS.md` locally for project notes.
|
||||
- `model-dir` prints the project model directory convention. The first project command creates `.autodl-remote/CONVENTIONS.md` locally for concise project notes.
|
||||
- `shutdown` first syncs the remote filesystem, then tries provider-safe shutdown methods, waits, and verifies that SSH disconnects.
|
||||
- Treat broad destructive commands as dangerous; require explicit user approval before using `--allow-dangerous`.
|
||||
Reference in new issue
Block a user