{"id":13903104,"url":"https://github.com/hackmdio/hackmd-cli","last_synced_at":"2025-09-08T12:32:16.998Z","repository":{"id":39660560,"uuid":"200339274","full_name":"hackmdio/hackmd-cli","owner":"hackmdio","description":"The HackMD/CodiMD Command Line Tool","archived":false,"fork":false,"pushed_at":"2023-09-27T23:19:09.000Z","size":1102,"stargazers_count":115,"open_issues_count":21,"forks_count":11,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2025-01-02T10:15:48.492Z","etag":null,"topics":["cli","codimd","oclif","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/hackmdio/hackmd-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackmdio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-08-03T06:11:15.000Z","updated_at":"2024-11-28T18:27:44.000Z","dependencies_parsed_at":"2024-01-14T04:40:18.738Z","dependency_job_id":"15f9ddec-aa0c-434d-8102-a318a676edae","html_url":"https://github.com/hackmdio/hackmd-cli","commit_stats":{"total_commits":114,"total_committers":7,"mean_commits":"16.285714285714285","dds":"0.32456140350877194","last_synced_commit":"fc10f186833724a902f4faefa48b6e711c716faa"},"previous_names":["hackmdio/codimd-cli"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fhackmd-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fhackmd-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fhackmd-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fhackmd-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackmdio","download_url":"https://codeload.github.com/hackmdio/hackmd-cli/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232207960,"owners_count":18488761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","codimd","oclif","typescript"],"created_at":"2024-08-06T22:01:37.283Z","updated_at":"2025-01-03T08:13:37.890Z","avatar_url":"https://github.com/hackmdio.png","language":"TypeScript","readme":"# hackmd-cli - The HackMD Command Line Tool\n\n[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n[![Version](https://img.shields.io/npm/v/@hackmd/hackmd-cli.svg)](https://npmjs.org/package/@hackmd/hackmd-cli)\n[![Downloads/week](https://img.shields.io/npm/dw/@hackmd/hackmd-cli.svg)](https://npmjs.org/package/@hackmd/hackmd-cli)\n[![License](https://img.shields.io/npm/l/@hackmd/hackmd-cli.svg)](https://github.com/hackmdio/hackmd-cli/blob/master/package.json)\n\n* [Usage](#usage)\n* [Commands](#commands)\n* [Configuration](#configuration)\n* [License](#license)\n\n## v2 notice\n\n`hackmd-cli` v2 now only supports the official HackMD instance([hackmd.io](https://hackmd.io)) and HackMD EE instances after version `1.38.1`. CodiMD is not supported anymore. If you want to use the CLI tools with CodiMD, please check out the [`v1.x` README](https://github.com/hackmdio/hackmd-cli/tree/v1.2.0) and follow the instruction there.\n\n### Migrating from v1.x\n\n1. If you are using the CLI with CodiMD, please follow the [`v1.x` README](https://github.com/hackmdio/hackmd-cli/tree/v1.2.0)\n2. If you are using the CLI with HackMD([hackmd.io](https://hackmd.io)) or HackMD EE(Enterprise Edition) instances:\n    * **You're using the JSON file-based config**: Remove `~/.hackmd/config.json` and start over again. You can start with [configuration](#configuration) section.\n    * **You're using environment variable based config**: `HMD_CLI_SERVER_URL` has been replaced with `HMD_API_ENDPOINT_URL`. And `HMD_API_ENDPOINT_URL` may vary depending on your instance. Please check contact your instance admin to get the correct `HMD_API_ENDPOINT_URL`. For generating access token, please check the [configuration](#configuration) section. You'll need to set the `HMD_API_ACCESS_TOKEN` environment variable.\n\n## Usage\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g @hackmd/hackmd-cli\n$ hackmd-cli COMMAND\nrunning command...\n$ hackmd-cli (--version|-v)\n@hackmd/hackmd-cli/2.3.2 darwin-arm64 node-v18.14.2\n$ hackmd-cli --help [COMMAND]\nUSAGE\n  $ hackmd-cli COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n\n## Configuration\n\n### Set access token\n\nAccess token should be set before using `hackmd-cli`. It can be created by landing [hackmd.io](https://hackmd.io) -\u003e [Setting](https://hackmd.io/settings#api) -\u003e [API](https://hackmd.io/settings#api) -\u003e Create API token. Copy the token and set it as config variable. For more details, please follow the tutorial: [How to issue an API token](https://hackmd.io/@hackmd-api/developer-portal/https%3A%2F%2Fhackmd.io%2F%40hackmd-api%2Fhow-to-issue-an-api-token).\n\n#### Example:\n\nSet the access token by `login` command. By doing so, the access token will be saved in `~/.hackmd/config.json`.\n\n```sh-session\n$ hackmd-cli login\nEnter your access token: My_ACCESS_TOKEN\n```\n\nOr you don't want to keep the credentials in one file, you can set it through environment variable:\n\n```bash\nexport HMD_API_ACCESS_TOKEN=MY_ACCESS_TOKEN\n```\n\nOr you can write the configuration file manually. Edit `~/.hackmd/config.json` with the following content:\n\n```json\n{\n  \"accessToken\": \"MY_ACCESS_TOKEN\"\n}\n```\n\n### Specify HackMD API endpoint manually (optional)\n\n`hackmd-cli` operates on the official HackMD API endpoint (`https://api.hackmd.io/v1`) by default. If you want to use `hackmd-cli` with a custom [HackMD EE](https://hackmd.io/enterprise) instance, you will need to configure the API endpoint by either environment variable or JSON configuration manually.\n\n#### Example:\n\nSet environment variable in your shell profile:\n\n```bash\nexport HMD_API_ENDPOINT_URL=https://my.hackmd-ee.api.endpoint\n```\n\nOr in JSON file (`~/.hackmd/config.json`):\n\n```json\n{\n  \"hackmdAPIEndpointURL\": \"https://my.hackmd-ee.api.endpoint\"\n}\n```\n\n### Configuration Reference\n\nAll available configurations are listed in the table below.\n\n|       Config key       |  Environment Variable  | Data Type  |              Example Value              |         Description         |\n| ---------------------- | :--------------------- | ---------- | --------------------------------------- | --------------------------- |\n| `hackmdAPIEndpointURL` | `HMD_API_ENDPOINT_URL` | *`string`* | `https://api.hackmd.io/v1`              | HackMD EE API endpoint URL  |\n| `accessToken`          | `HMD_API_ACCESS_TOKEN` | *`string`* | `UFHR12H7FSEF3ADFY3N9YNRN2E49VGR212NBF` | Token to access HackMD APIs |\n\n## Commands\n\n\u003c!-- commands --\u003e\n* [`hackmd-cli autocomplete [SHELL]`](#hackmd-cli-autocomplete-shell)\n* [`hackmd-cli export`](#hackmd-cli-export)\n* [`hackmd-cli help [COMMANDS]`](#hackmd-cli-help-commands)\n* [`hackmd-cli history`](#hackmd-cli-history)\n* [`hackmd-cli login`](#hackmd-cli-login)\n* [`hackmd-cli logout`](#hackmd-cli-logout)\n* [`hackmd-cli notes`](#hackmd-cli-notes)\n* [`hackmd-cli notes create`](#hackmd-cli-notes-create)\n* [`hackmd-cli notes delete`](#hackmd-cli-notes-delete)\n* [`hackmd-cli notes update`](#hackmd-cli-notes-update)\n* [`hackmd-cli team-notes`](#hackmd-cli-team-notes)\n* [`hackmd-cli team-notes create`](#hackmd-cli-team-notes-create)\n* [`hackmd-cli team-notes delete`](#hackmd-cli-team-notes-delete)\n* [`hackmd-cli team-notes update`](#hackmd-cli-team-notes-update)\n* [`hackmd-cli teams`](#hackmd-cli-teams)\n* [`hackmd-cli version`](#hackmd-cli-version)\n* [`hackmd-cli whoami`](#hackmd-cli-whoami)\n\n## `hackmd-cli autocomplete [SHELL]`\n\ndisplay autocomplete installation instructions\n\n```\nUSAGE\n  $ hackmd-cli autocomplete [SHELL] [-r]\n\nARGUMENTS\n  SHELL  shell type\n\nFLAGS\n  -r, --refresh-cache  Refresh cache (ignores displaying instructions)\n\nDESCRIPTION\n  display autocomplete installation instructions\n\nEXAMPLES\n  $ hackmd-cli autocomplete\n\n  $ hackmd-cli autocomplete bash\n\n  $ hackmd-cli autocomplete fish\n\n  $ hackmd-cli autocomplete zsh\n\n  $ hackmd-cli autocomplete --refresh-cache\n```\n\n_See code: [@hackmd/oclif-plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.1.9-fish/src/commands/autocomplete/index.ts)_\n\n## `hackmd-cli export`\n\nExport note content\n\n```\nUSAGE\n  $ hackmd-cli export [-h] [--noteId \u003cvalue\u003e]\n\nFLAGS\n  -h, --help        Show CLI help.\n  --noteId=\u003cvalue\u003e  HackMD note id\n\nDESCRIPTION\n  Export note content\n\nEXAMPLES\n  $ hackmd-cli export --noteId=kNFWV5E-Qz-QP7u6XnNvyQ\n  # A note to be exported\n```\n\n_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/export.ts)_\n\n## `hackmd-cli help [COMMANDS]`\n\nDisplay help for hackmd-cli.\n\n```\nUSAGE\n  $ hackmd-cli help [COMMANDS] [-n]\n\nARGUMENTS\n  COMMANDS  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for hackmd-cli.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_\n\n## `hackmd-cli history`\n\nList user browse history\n\n```\nUSAGE\n  $ hackmd-cli history [-h] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter \u003cvalue\u003e] [--output\n    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -h, --help         Show CLI help.\n  -x, --extended     show extra columns\n  --columns=\u003cvalue\u003e  only show provided columns (comma-separated)\n  --csv              output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e   filter property by partial string matching, ex: name=foo\n  --no-header        hide table header from output\n  --no-truncate      do not truncate output to fit screen\n  --output=\u003coption\u003e  output in a more machine friendly format\n                     \u003coptions: csv|json|yaml\u003e\n  --sort=\u003cvalue\u003e     property to sort by (prepend '-' for descending)\n\nDESCRIPTION\n  List user browse history\n\nEXAMPLES\n  $ hackmd-cli history\n  ID                     Title                            User Path               Team Path\n  ────────────────────── ──────────────────────────────── ────────────────────── ────────\n  raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q null\n  BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null                   CLI-test\n```\n\n_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/history.ts)_\n\n## `hackmd-cli login`\n\nLogin to HackMD server from CLI\n\n```\nUSAGE\n  $ hackmd-cli login [-h]\n\nFLAGS\n  -h, --help  Show CLI help.\n\nDESCRIPTION\n  Login to HackMD server from CLI\n\nEXAMPLES\n  $ hackmd-cli login\n  Enter your access token: MY_ACCESS_TOKEN\n  Login successfully\n```\n\n_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/login.ts)_\n\n## `hackmd-cli logout`\n\nLogin to HackMD server from CLI\n\n```\nUSAGE\n  $ hackmd-cli logout [-h]\n\nFLAGS\n  -h, --help  Show CLI help.\n\nDESCRIPTION\n  Login to HackMD server from CLI\n\nEXAMPLES\n  $ hackmd-cli logout\n  You've logged out successfully\n```\n\n_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/logout.ts)_\n\n## `hackmd-cli notes`\n\nHackMD notes commands\n\n```\nUSAGE\n  $ hackmd-cli notes [-h] [--noteId \u003cvalue\u003e] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter \u003cvalue\u003e]\n    [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -h, --help         Show CLI help.\n  -x, --extended     show extra columns\n  --columns=\u003cvalue\u003e  only show provided columns (comma-separated)\n  --csv              output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e   filter property by partial string matching, ex: name=foo\n  --no-header        hide table header from output\n  --no-truncate      do not truncate output to fit screen\n  --noteId=\u003cvalue\u003e   HackMD note id\n  --output=\u003coption\u003e  output in a more machine friendly format\n                     \u003coptions: csv|json|yaml\u003e\n  --sort=\u003cvalue\u003e     property to sort by (prepend '-' for descending)\n\nDESCRIPTION\n  HackMD notes commands\n\nEXAMPLES\n  $ hackmd-cli notes\n  ID                     Title                            User Path               Team Path\n  ────────────────────── ──────────────────────────────── ────────────────────── ────────\n  raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q null\n```\n\n_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/notes/index.ts)_\n\n## `hackmd-cli notes create`\n\nCreate a note\n\n```\nUSAGE\n  $ hackmd-cli notes create [-h] [--title \u003cvalue\u003e] [--content \u003cvalue\u003e] [--readPermission \u003cvalue\u003e]\n    [--writePermission \u003cvalue\u003e] [--commentPermission \u003cvalue\u003e] [-e] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter\n    \u003cvalue\u003e] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -e, --editor                 create note with $EDITOR\n  -h, --help                   Show CLI help.\n  -x, --extended               show extra columns\n  --columns=\u003cvalue\u003e            only show provided columns (comma-separated)\n  --commentPermission=\u003cvalue\u003e  set comment permission: disabled, forbidden, owners, signed_in_users, everyone\n  --content=\u003cvalue\u003e            new note content\n  --csv                        output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e             filter property by partial string matching, ex: name=foo\n  --no-header                  hide table header from output\n  --no-truncate                do not truncate output to fit screen\n  --output=\u003coption\u003e            output in a more machine friendly format\n                               \u003coptions: csv|json|yaml\u003e\n  --readPermission=\u003cvalue\u003e     set note permission: owner, signed_in, guest\n  --sort=\u003cvalue\u003e               property to sort by (prepend '-' for descending)\n  --title=\u003cvalue\u003e              new note title\n  --writePermission=\u003cvalue\u003e    set note permission: owner, signed_in, guest\n\nDESCRIPTION\n  Create a note\n\nEXAMPLES\n  notes create --content='# A new note' --readPermission=owner --writePermission=owner --commentPermission=disabled\n\n  ID                     Title                            User Path               Team Path\n  ────────────────────── ──────────────────────────────── ──────────────────────  ────────\n  raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q  null\n\n  Or you can pipe content via Unix pipeline:\n\n  cat README.md | hackmd-cli notes create\n```\n\n## `hackmd-cli notes delete`\n\nDelete a note\n\n```\nUSAGE\n  $ hackmd-cli notes delete [-h] [--noteId \u003cvalue\u003e]\n\nFLAGS\n  -h, --help        Show CLI help.\n  --noteId=\u003cvalue\u003e  HackMD note id\n\nDESCRIPTION\n  Delete a note\n\nEXAMPLES\n  $ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA\n```\n\n## `hackmd-cli notes update`\n\nUpdate note content\n\n```\nUSAGE\n  $ hackmd-cli notes update [-h] [--noteId \u003cvalue\u003e] [--content \u003cvalue\u003e]\n\nFLAGS\n  -h, --help         Show CLI help.\n  --content=\u003cvalue\u003e  new note content\n  --noteId=\u003cvalue\u003e   HackMD note id\n\nDESCRIPTION\n  Update note content\n\nEXAMPLES\n  $ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'\n```\n\n## `hackmd-cli team-notes`\n\nHackMD team-notes commands\n\n```\nUSAGE\n  $ hackmd-cli team-notes [-h] [--teamPath \u003cvalue\u003e] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter \u003cvalue\u003e]\n    [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -h, --help          Show CLI help.\n  -x, --extended      show extra columns\n  --columns=\u003cvalue\u003e   only show provided columns (comma-separated)\n  --csv               output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e    filter property by partial string matching, ex: name=foo\n  --no-header         hide table header from output\n  --no-truncate       do not truncate output to fit screen\n  --output=\u003coption\u003e   output in a more machine friendly format\n                      \u003coptions: csv|json|yaml\u003e\n  --sort=\u003cvalue\u003e      property to sort by (prepend '-' for descending)\n  --teamPath=\u003cvalue\u003e  HackMD team path\n\nDESCRIPTION\n  HackMD team-notes commands\n\nEXAMPLES\n  $ hackmd-cli team-notes --teamPath=CLI-test\n  ID                     Title                            User path Team path\n  ────────────────────── ──────────────────────────────── ──────── ────────\n  WNkLM6gkS0Cg2cQ8rv7bYA a team note                      null     CLI-test\n  BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test\n```\n\n_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/team-notes/index.ts)_\n\n## `hackmd-cli team-notes create`\n\nCreate a team note\n\n```\nUSAGE\n  $ hackmd-cli team-notes create [-h] [--teamPath \u003cvalue\u003e] [--title \u003cvalue\u003e] [--content \u003cvalue\u003e] [--readPermission\n    \u003cvalue\u003e] [--writePermission \u003cvalue\u003e] [--commentPermission \u003cvalue\u003e] [-e] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e]\n    [--filter \u003cvalue\u003e] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -e, --editor                 create note with $EDITOR\n  -h, --help                   Show CLI help.\n  -x, --extended               show extra columns\n  --columns=\u003cvalue\u003e            only show provided columns (comma-separated)\n  --commentPermission=\u003cvalue\u003e  set comment permission: disabled, forbidden, owners, signed_in_users, everyone\n  --content=\u003cvalue\u003e            new note content\n  --csv                        output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e             filter property by partial string matching, ex: name=foo\n  --no-header                  hide table header from output\n  --no-truncate                do not truncate output to fit screen\n  --output=\u003coption\u003e            output in a more machine friendly format\n                               \u003coptions: csv|json|yaml\u003e\n  --readPermission=\u003cvalue\u003e     set note permission: owner, signed_in, guest\n  --sort=\u003cvalue\u003e               property to sort by (prepend '-' for descending)\n  --teamPath=\u003cvalue\u003e           HackMD team path\n  --title=\u003cvalue\u003e              new note title\n  --writePermission=\u003cvalue\u003e    set note permission: owner, signed_in, guest\n\nDESCRIPTION\n  Create a team note\n\nEXAMPLES\n  team-notes:create --teamPath=CLI-test --content='# A new note' --readPermission=owner --writePermission=owner --commentPermission=disabled\n  ID                     Title                            User Path              Team Path\n  ────────────────────── ──────────────────────────────── ────────────────────── ────────\n  raUuSTetT5uQbqQfLnz9lA A new note                       gvfz2UB5THiKABQJQnLs6Q null     \n\n  Or you can pipe content via Unix pipeline:\n\n  cat README.md | hackmd-cli notes create --teamPath=CLI-test\n```\n\n## `hackmd-cli team-notes delete`\n\nDelete a team note\n\n```\nUSAGE\n  $ hackmd-cli team-notes delete [-h] [--teamPath \u003cvalue\u003e] [--noteId \u003cvalue\u003e]\n\nFLAGS\n  -h, --help          Show CLI help.\n  --noteId=\u003cvalue\u003e    HackMD note id\n  --teamPath=\u003cvalue\u003e  HackMD team path\n\nDESCRIPTION\n  Delete a team note\n\nEXAMPLES\n  $ hackmd-cli team-notes delete --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA\n```\n\n## `hackmd-cli team-notes update`\n\nUpdate team note content\n\n```\nUSAGE\n  $ hackmd-cli team-notes update [-h] [--teamPath \u003cvalue\u003e] [--noteId \u003cvalue\u003e] [--content \u003cvalue\u003e]\n\nFLAGS\n  -h, --help          Show CLI help.\n  --content=\u003cvalue\u003e   new note content\n  --noteId=\u003cvalue\u003e    HackMD note id\n  --teamPath=\u003cvalue\u003e  HackMD team path\n\nDESCRIPTION\n  Update team note content\n\nEXAMPLES\n  $ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'\n```\n\n## `hackmd-cli teams`\n\nList teams\n\n```\nUSAGE\n  $ hackmd-cli teams [-h] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter \u003cvalue\u003e] [--output\n    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -h, --help         Show CLI help.\n  -x, --extended     show extra columns\n  --columns=\u003cvalue\u003e  only show provided columns (comma-separated)\n  --csv              output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e   filter property by partial string matching, ex: name=foo\n  --no-header        hide table header from output\n  --no-truncate      do not truncate output to fit screen\n  --output=\u003coption\u003e  output in a more machine friendly format\n                     \u003coptions: csv|json|yaml\u003e\n  --sort=\u003cvalue\u003e     property to sort by (prepend '-' for descending)\n\nDESCRIPTION\n  List teams\n\nEXAMPLES\n  $ hackmd-cli teams\n  ID                                   Name          Path     Owner ID\n  ──────────────────────────────────── ───────────── ──────── ────────────────────────────────────\n  f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8a00-14094272ece9\n```\n\n_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/teams.ts)_\n\n## `hackmd-cli version`\n\n```\nUSAGE\n  $ hackmd-cli version [--json] [--verbose]\n\nFLAGS\n  --verbose  Show additional information about the CLI.\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nFLAG DESCRIPTIONS\n  --verbose  Show additional information about the CLI.\n\n    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.\n```\n\n_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.3.3/src/commands/version.ts)_\n\n## `hackmd-cli whoami`\n\nShow current user information\n\n```\nUSAGE\n  $ hackmd-cli whoami [-h] [--columns \u003cvalue\u003e | -x] [--sort \u003cvalue\u003e] [--filter \u003cvalue\u003e] [--output\n    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]\n\nFLAGS\n  -h, --help         Show CLI help.\n  -x, --extended     show extra columns\n  --columns=\u003cvalue\u003e  only show provided columns (comma-separated)\n  --csv              output is csv format [alias: --output=csv]\n  --filter=\u003cvalue\u003e   filter property by partial string matching, ex: name=foo\n  --no-header        hide table header from output\n  --no-truncate      do not truncate output to fit screen\n  --output=\u003coption\u003e  output in a more machine friendly format\n                     \u003coptions: csv|json|yaml\u003e\n  --sort=\u003cvalue\u003e     property to sort by (prepend '-' for descending)\n\nDESCRIPTION\n  Show current user information\n\nEXAMPLES\n  $ hackmd-cli whoami\n  ID                                   Name           Email User path\n  ──────────────────────────────────── ────────────── ───── ──────────────────────\n  82f7f3d9-4079-4c78-8a00-14094272ece9 Ming-Hsiu Tsai null  gvfz2UB5THiKABQJQnLs6Q\n```\n\n_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/whoami.ts)_\n\u003c!-- commandsstop --\u003e\n\n## License\n\nMIT\n","funding_links":[],"categories":["cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fhackmd-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackmdio%2Fhackmd-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fhackmd-cli/lists"}