# obsidian-pkt

**Repository Path**: git4rocking/obsidian-pkt

## Basic Information

- **Project Name**: obsidian-pkt
- **Description**: 操作obsidian 的一些命令行工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-24
- **Last Updated**: 2026-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Personal Knowledge Toolkit

PKT is a Python command line toolkit for operating an Obsidian vault directly
from Markdown files and directories.

## Install for Development

```bash
python3 -m pip install -e .
```

## Configure

Create `~/.config/pkt/config.yaml`, or pass `--config` to the CLI.

```bash
pkt config init
```

This writes a starter config file. Edit `vault_path` so it points to your
Obsidian vault root directory.

To pre-fill the vault path:

```bash
pkt --vault-path "/Users/oliver/Library/Mobile Documents/iCloud~md~obsidian/Documents/知识库/" config init
```

```yaml
vault_path: /Users/oliver/Library/Mobile Documents/iCloud~md~obsidian/Documents/知识库/

daily_dir: 01-Daily
inbox_dir: 00-Inbox
template_dir: 90-templates
articles_dir: 08-Material

timezone: Asia/Shanghai

daily_use_year_dir: true

default_tags:
  - obsidian

weather:
  enabled: true
  city: 上海
  latitude: 31.2304
  longitude: 121.4737
  timeout_seconds: 4

oss_config:
  OSS_ACCESS_KEY_ID: ""
  OSS_ACCESS_KEY_SECRET: ""
  OSS_BUCKET: ""
  OSS_ENDPOINT: ""
  OSS_BASE_URL: ""
  OSS_IMAGE_PREFIX: image-ob
  OSS_IMAGE_NAME_STRATEGY: timestamp
```

You can also create a project-local config file:

```bash
pkt config init --local
```

## Commands

```bash
pkt daily
```

Creates today's note under:

```text
<vault_path>/<daily_dir>/<year>/<YYYY年MM月DD日_周X.md>
```

If the note already exists, PKT leaves it unchanged.

### Import WeChat Articles

```bash
pkt import url="https://mp.weixin.qq.com/s/xxxxx"
```

Imported Markdown files are written to:

```text
<vault_path>/<articles_dir>/<article-title>.md
```

Images in the article are uploaded to OSS and rewritten to OSS URLs in the
Markdown content. `OSS_IMAGE_NAME_STRATEGY` supports `timestamp` or `uuid`.