---
title: "property.list: List the properties — Note kit command — Kition"
description: "Lists the front-matter properties with key, value, type, writing style and lines, and reports duplicated keys and YAML it cannot read. Use it before `property.set`, `property.delete` or `property.rename`."
canonical: "https://developer.kition.ai/docs/kits/note/commands/property.list"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/note/commands/property.list](https://developer.kition.ai/docs/kits/note/commands/property.list)

# property.list

**List the properties.** Lists the front-matter properties with key, value, type, writing style and lines, and reports duplicated keys and YAML it cannot read. Use it before `property.set`, `property.delete` or `property.rename`.

- Kit: Note 0.3.0 (Markdown (.md)); reference: [Note kit commands](https://developer.kition.ai/docs/kits/note.md)
- Changes the document: no

## Parameters

None.

## Call through note_run

```text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "property.list" }]
}
```

The required parameters, with placeholders for their types: not a tested example. note_run answers the step’s result in `completed[i].result`.

## Result

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `duplicates` | `string[]` | no | Keys written more than once. |
| `invalid` | `object` | no |  |
| `properties` | `object[]` | yes | The front matter's top-level properties, in order; empty without front matter. |

```json
{
  "additionalProperties": false,
  "properties": {
    "duplicates": {
      "description": "Keys written more than once.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "invalid": {
      "additionalProperties": false,
      "properties": {
        "line": {
          "description": "The line, from 1.",
          "type": "integer"
        },
        "message": {
          "description": "What is wrong.",
          "type": "string"
        }
      },
      "required": [
        "line",
        "message"
      ],
      "type": "object"
    },
    "properties": {
      "description": "The front matter's top-level properties, in order; empty without front matter.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "complex": {
            "description": "Why it is complex, when it is.",
            "type": "string"
          },
          "key": {
            "description": "The key.",
            "type": "string"
          },
          "lines": {
            "description": "Its first and last line, from 1.",
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "style": {
            "description": "How it is written; property.set keeps the style. A complex one is only replaced whole.",
            "enum": [
              "empty",
              "plain",
              "single-quoted",
              "double-quoted",
              "flow-list",
              "block-list",
              "complex"
            ],
            "type": "string"
          },
          "type": {
            "description": "What the value reads as; other is YAML the note does not type, unknown a value it could not read.",
            "enum": [
              "string",
              "number",
              "boolean",
              "null",
              "date",
              "datetime",
              "list",
              "other",
              "unknown"
            ],
            "type": "string"
          },
          "value": {
            "description": "The value: a string (dates too), number, boolean, list of strings, or null."
          }
        },
        "required": [
          "key",
          "lines",
          "style",
          "type",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "properties"
  ],
  "type": "object"
}
```

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9).
