au3 note — Command Reference

CLI command group: au3 note

Commands for creating, viewing, updating, and deleting notes.

---

au3 note list

List notes

Option	Type	Required	Default	Notes
--fields	string			Comma-separate list of fields to display
--filter	string			Filter in JSON/YAML format or path to file containing filter
--sort	string			Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search	string			Search in JSON/YAML format or path to file containing search
--limit			100	Number of results to fetch
--skip				Number of results to skip
--all	boolean		false	Whether to fetch results from all pages
--stream	boolean		false	Whether to print results as they are received without buffering (as JSON)
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 note view

View note

Option	Type	Required	Default	Notes
--id	string	✅		note id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 note create

Create note

Option	Type	Required	Default	Notes
--target	string	✅		Id of target object which the note is about
--target_type	enum	✅		Type of target object which the note is about Choices: "Bucket", "SolutionInstallation", "SolutionInstallationAcquisitionTransfer", "SolutionInstallationDeliveryTransfer", "Warehouse", "WarehouseDataflow", "WarehouseDataflowOperation", "WarehouseEntity", "WarehouseEntityField"
--title	string			Object name with 2-64 characters
--category	enum	✅	uncategorized	Category denoting the format and/or purpose of the note content Choices: "uncategorized"
--format	enum	✅	markdown	Choices: "markdown"
--body	string	✅
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 note update

Update note

Option	Type	Required	Default	Notes
--id	string			Note id
--title	string			Object name with 2-64 characters
--category	enum			Category denoting the format and/or purpose of the note content Choices: "uncategorized"
--format	enum			Choices: "markdown"
--body	string
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 note list-history

List note history

Option	Type	Required	Default	Notes
--id	string	✅		note id
--fields	string			comma-separate list of fields to display
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

au3 note delete

Delete a note

Option	Type	Required	Default	Notes
--id	string	✅		Note id
--trash	boolean		true
--fmt	enum		human	Output format Choices: "human", "json", "yaml"
--debug	boolean		false	Enable more verbose output on error

---

Generated from au3 note --help and subcommand help output.