Skip to content

feat(notebooks): add --markdown to get, create, update, and edit #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andyjmorgan wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(notebooks): add --markdown to get, create, update, and edit #750

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion docs/COMMANDS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ pup <domain> <subgroup> <action> [options] # Nested commands
| logs-restriction | list, get, create, update, delete, roles (list, add) | src/commands/logs_restriction.rs | ✅ |
| processes | list | src/commands/processes.rs | ✅ |
| users | list, get, roles, service-accounts (create, app-keys CRUD) | src/commands/users.rs | ✅ |
| notebooks | list, get, create, update, diff, delete, annotations (list, get-page, create, update, delete) | src/commands/notebooks.rs, src/commands/annotations.rs | ✅ |
| notebooks | list, get, create, update, edit, diff, delete (get/create/update/edit accept `--markdown`), annotations (list, get-page, create, update, delete) | src/commands/notebooks.rs, src/commands/annotations.rs | ✅ |
| security | rules, signals, findings, content-packs, risk-scores | src/commands/security.rs | ✅ |
| organizations | get, list | src/commands/organizations.rs | ✅ |
| service-catalog | list, get | src/commands/service_catalog.rs | ✅ |
Expand Down Expand Up @@ -273,6 +273,33 @@ steps) bypass `format_and_print` and do not honor `--jq`.

## Recent Enhancements

### Notebooks — Markdown representation (experimental)

`notebooks get`, `create`, `update`, and `edit` accept `--markdown` to work with a
notebook as a Markdown document instead of a JSON cells array. These call
`/api/unstable/notebooks`, which the notebooks team has not yet promoted to
`/api/v2`; the path and response contract may still change.

- `get --markdown` — print the notebook as Markdown (YAML frontmatter + body)
- `create --markdown --file doc.md` — create from a Markdown file
- `update --markdown --file doc.md` — replace the whole document
- `edit --markdown --file fragment.md` — append the fragment server-side

Constraints worth knowing before relying on these:

- **Rich-text notebooks only.** Notebooks created through the older cells API have
no Markdown projection, and the API returns an error for them.
- **`update --markdown` is lossy.** It replaces the entire document, and anything
Markdown cannot represent is dropped. The JSON path preserves more.
- **No conflict detection.** `document_revision` is returned but not enforced by
the API, so concurrent writers can overwrite each other on any write path.
- **No targeted edits.** `update` replaces and `edit` appends; there is no way to
modify one section in place.
- `--jq` is rejected with `--markdown`, since the output is not JSON.
- `--output` and agent mode have no effect under `--markdown`: the document is
printed as-is, with no envelope and no format conversion. This matches
`skills remote get`, the other command that emits raw Markdown.

### v0.64.x — Error Tracking Issue Filters (SDK PRs #1568, #1480)

- **error-tracking issues search** — new optional filter flags:
Expand Down
Loading