blogsync

https://github.com/x-motemen/blogsync
Admin
blogsync is a CLI client for Hatena Blog that allows users to download, update, and post blog...
Tokens:3,477
Snippets:45
Trust Score:8.4
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install blogsync from source

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Install the latest version of blogsync directly from the source code using Go.

```go
go install github.com/x-motemen/blogsync@latest
```

--------------------------------

### Install blogsync with Homebrew

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Use this command to install the latest stable version of blogsync using Homebrew.

```console
% brew install Songmu/tap/blogsync
```

--------------------------------

### Blogsync Default Configuration Example

Source: https://github.com/x-motemen/blogsync/blob/master/doc/file-structure.md

An example of a potential default configuration structure that blogsync might have originally intended, with a shared `local_root` and other settings.

```yaml
songmu.hateblo.jp:
songmu.hatenablog.com:
default:
  local_root: /Users/Songmu/Blogs
  username: Songmu
  ...
```

--------------------------------

### blogsync Configuration Example

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Example YAML configuration for blogsync, specifying blog ID, username, password (API key), and local root directory. The 'default' key provides fallback values for all blogs.

```yaml
motemen.hatenablog.com:
  username: motemen
  password: <API KEY>
default:
  local_root: /Users/motemen/Dropbox/Blog
```

--------------------------------

### Install blogsync via GitHub Actions

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

This snippet shows how to install and use the blogsync tool within a GitHub Actions workflow. It specifies the action and version to be used.

```yaml
uses: x-motemen/blogsync@v0
```

--------------------------------

### Configure local_root for blogsync

Source: https://github.com/x-motemen/blogsync/blob/master/doc/file-structure.md

Sets the base directory for blogsync content. Blog content will be placed in `$local_root/$blogID`.

```yaml
songmu.hateblo.jp:
  local_root: /Users/Songmu/Blog
```

--------------------------------

### blogsync Configuration for Custom Entry Directory

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Configure blogsync when the entry directory on Hatena Blog has been changed from the default. Specify the custom directory name here.

```yaml
example.hatenablog.com:
  username: sample
  password: <API KEY>
  entry_directory: articles
```

--------------------------------

### Publish Draft Entry with blogsync push --publish

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

This command is used to publish a draft entry. You can either use the `--publish` flag with `blogsync push` or remove the `Draft: true` line from the front matter and then use `blogsync push`. If a custom path was not specified for a draft, the file will be moved to its permanent location with a confirmed URL upon publishing.

```sh
blogsync push --publish <path/to/file>
```

--------------------------------

### Post New Blog Entry with blogsync post

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Use this command to post a new blog entry that does not yet exist on the blog platform. The command accepts the blog name and reads the entry content from standard input. It then downloads the newly created entry, allowing for subsequent edits via `blogsync push`. Options like `--title` and `--draft` can be used to specify the title and draft status.

```sh
% blogsync post <blog> < <path/to/file>
```

```console
% blogsync post --draft --title=blogsync motemen.hatenablog.com
さてかきはじめるか…
^D
```

--------------------------------

### Fetch Remote Entry Updates with blogsync fetch

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Use this command to incorporate remote updates into a specific entry file. This is useful for synchronizing local files with the latest changes on the blog platform.

```sh
% blogsync fetch <path/to/file>
```

--------------------------------

### Update Blog Entry with blogsync push

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Use this command to update an existing blog entry by pushing local file changes. If the local file is not newer than the remote entry, no update request is made. This command also supports renaming or moving files, which will update the public URL accordingly.

```sh
% blogsync push <path/to/file>
```

```console
% blogsync push ~/Dropbox/blog/motemen.hatenablog.com/entry/2014/12/22/blogsync.md
       GET ---> https://blog.hatena.ne.jp/motemen/motemen.hatenablog.com/atom/entry/8454420450077731341
       200 <--- https://blog.hatena.ne.jp/motemen/motemen.hatenablog.com/atom/entry/8454420450077731341
       PUT ---> https://blog.hatena.ne.jp/motemen/motemen.hatenablog.com/atom/entry/8454420450077731341
       200 <--- https://blog.hatena.ne.jp/motemen/motemen.hatenablog.com/atom/entry/8454420450077731341
     store /Users/motemen/Dropbox/blog/motemen.hatenablog.com/entry/2014/12/22/blogsync.md
```

--------------------------------

### blogsync Configuration with Owner Override

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Configure blogsync for blogs where the owner is different from the editor. This is useful for collaborative blogs.

```yaml
example.hatenablog.com:
  username: sample
  password: <API KEY>
  owner: <OWNER>
```

--------------------------------

### Pull blog entries

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Download all entries from a specified blog ID to the local machine. If the blog ID is omitted, it defaults to the configuration in blogsync.yaml.

```sh
blogsync pull <blogID>
```

--------------------------------

### blogsync Entry File Format

Source: https://github.com/x-motemen/blogsync/blob/master/README.md

Local blog entries are stored in a format with YAML Frontmatter metadata followed by the article body. This structure includes Title, Date, URL, EditURL, Category, and Draft status.

```markdown
---
Title:   まだmechanizeで消耗してるの? WebDriverで銀行をスクレイピング（ProtractorとWebdriverIOを例に）
Category:
- scraping
Date:    2014-10-01T08:30:00+09:00
URL:     http://motemen.hatenablog.com/entry/2014/10/01/scrape-by-protractor-webdriverio
EditURL: https://blog.hatena.ne.jp/motemen/motemen.hatenablog.com/atom/entry/8454420450066634133
---

今日はスクレイピングの話をします。…
```

--------------------------------

### Save Drafts in blogsync

Source: https://github.com/x-motemen/blogsync/blob/master/doc/file-structure.md

Draft entries without a custom path are saved to `entry/_draft/$entryID.md`, where `$entryID` is derived from the entry's EditURL.

```yaml
entry/_draft/$entryID.md
```

--------------------------------

### Omit Domain in blogsync Path

Source: https://github.com/x-motemen/blogsync/blob/master/doc/file-structure.md

When `omit_domain` is true, blogsync places content directly into `local_root` instead of creating a subdirectory for the blog ID.

```yaml
songmu.hateblo.jp:
  local_root: /Users/Songmu/Blog
  omit_domain: true
```
Tokens:
Raw