Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/beeman/dev-to-sync

Two-way sync of your DEV account with a local folder.
https://github.com/beeman/dev-to-sync

devto markdown sync

Last synced: 2 months ago
JSON representation

Two-way sync of your DEV account with a local folder.

Host: GitHub
URL: https://github.com/beeman/dev-to-sync
Owner: beeman
License: mit
Created: 2020-07-08T11:10:51.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2021-04-01T04:10:55.000Z (almost 4 years ago)
Last Synced: 2024-10-12T01:28:49.532Z (3 months ago)
Topics: devto, markdown, sync
Language: TypeScript
Homepage: https://npm.im/dev-to-sync
Size: 423 KB
Stars: 5
Watchers: 2
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # dev-to-sync

Two-way sync of your DEV account with a local folder.

This tool is inspired by (and uses code) from [dev-to-git](https://github.com/maxime1992/dev-to-git), which implements one-way local -> DEV sync.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/dev-to-sync.svg)](https://npmjs.org/package/dev-to-sync)

[![CircleCI](https://circleci.com/gh/beeman/dev-to-sync/tree/master.svg?style=shield)](https://circleci.com/gh/beeman/dev-to-sync/tree/master)

[![Downloads/week](https://img.shields.io/npm/dw/dev-to-sync.svg)](https://npmjs.org/package/dev-to-sync)

[![License](https://img.shields.io/npm/l/dev-to-sync.svg)](https://github.com/beeman/dev-to-sync/blob/master/package.json)

* [dev-to-sync](#dev-to-sync)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g dev-to-sync

$ dev-to-sync COMMAND

running command...

$ dev-to-sync (-v|--version|version)

dev-to-sync/0.5.0 darwin-x64 node-v12.18.2

$ dev-to-sync --help [COMMAND]

USAGE

  $ dev-to-sync COMMAND

...

```

# Commands

* [`dev-to-sync config:delete`](#dev-to-sync-configdelete)

* [`dev-to-sync config:edit`](#dev-to-sync-configedit)

* [`dev-to-sync config:get KEY`](#dev-to-sync-configget-key)

* [`dev-to-sync config:list`](#dev-to-sync-configlist)

* [`dev-to-sync config:set KEY VALUE`](#dev-to-sync-configset-key-value)

* [`dev-to-sync create TITLE`](#dev-to-sync-create-title)

* [`dev-to-sync hello [FILE]`](#dev-to-sync-hello-file)

* [`dev-to-sync help [COMMAND]`](#dev-to-sync-help-command)

* [`dev-to-sync list [INDEX]`](#dev-to-sync-list-index)

* [`dev-to-sync pull [INDEX]`](#dev-to-sync-pull-index)

* [`dev-to-sync push [INDEX]`](#dev-to-sync-push-index)

## `dev-to-sync config:delete`

Delete the config file

```

USAGE

  $ dev-to-sync config:delete

OPTIONS

  -g, --global  (required) Global config

  -h, --help    show CLI help

```

_See code: [src/commands/config/delete.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/config/delete.ts)_

## `dev-to-sync config:edit`

Edit the config file

```

USAGE

  $ dev-to-sync config:edit

OPTIONS

  -g, --global  (required) Global config

  -h, --help    show CLI help

```

_See code: [src/commands/config/edit.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/config/edit.ts)_

## `dev-to-sync config:get KEY`

Retrieve value from app config

```

USAGE

  $ dev-to-sync config:get KEY

OPTIONS

  -g, --global  (required) Global config

  -h, --help    show CLI help

```

_See code: [src/commands/config/get.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/config/get.ts)_

## `dev-to-sync config:list`

List app config

```

USAGE

  $ dev-to-sync config:list

OPTIONS

  -g, --global  (required) Global config

  -h, --help    show CLI help

```

_See code: [src/commands/config/list.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/config/list.ts)_

## `dev-to-sync config:set KEY VALUE`

Store value in app config

```

USAGE

  $ dev-to-sync config:set KEY VALUE

OPTIONS

  -g, --global  (required) Global config

  -h, --help    show CLI help

```

_See code: [src/commands/config/set.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/config/set.ts)_

## `dev-to-sync create TITLE`

Create an article on DEV

```

USAGE

  $ dev-to-sync create TITLE

```

_See code: [src/commands/create.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/create.ts)_

## `dev-to-sync hello [FILE]`

describe the command here

```

USAGE

  $ dev-to-sync hello [FILE]

OPTIONS

  -f, --force

  -h, --help       show CLI help

  -n, --name=name  name to print

EXAMPLE

  $ dev-to-sync hello

  hello world from ./src/hello.ts!

```

_See code: [src/commands/hello.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/hello.ts)_

## `dev-to-sync help [COMMAND]`

display help for dev-to-sync

```

USAGE

  $ dev-to-sync help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_

## `dev-to-sync list [INDEX]`

List articles in a DEV account

```

USAGE

  $ dev-to-sync list [INDEX]

```

_See code: [src/commands/list.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/list.ts)_

## `dev-to-sync pull [INDEX]`

Pull articles from the DEV api and save them in a local path.

```

USAGE

  $ dev-to-sync pull [INDEX]

OPTIONS

  --dir=dir  [default: posts] Name of the directory the articles will be stored in

```

_See code: [src/commands/pull.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/pull.ts)_

## `dev-to-sync push [INDEX]`

Read articles from a local path and push to DEV.

```

USAGE

  $ dev-to-sync push [INDEX]

OPTIONS

  -t, --timeout=timeout  [default: 500] Timeout in milliseconds between calls to DEV api

```

_See code: [src/commands/push.ts](https://github.com/beeman/dev-to-sync/blob/v0.5.0/src/commands/push.ts)_