Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shihanng/devto
CLI tool to publish article to https://dev.to/
https://github.com/shihanng/devto
cli devto go golang
Last synced: 2 months ago
JSON representation
CLI tool to publish article to https://dev.to/
- Host: GitHub
- URL: https://github.com/shihanng/devto
- Owner: shihanng
- License: mit
- Created: 2019-12-15T12:26:35.000Z (about 5 years ago)
- Default Branch: develop
- Last Pushed: 2020-09-17T23:13:18.000Z (over 4 years ago)
- Last Synced: 2024-06-20T03:50:07.192Z (7 months ago)
- Topics: cli, devto, go, golang
- Language: Go
- Homepage:
- Size: 204 KB
- Stars: 14
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# devto -- publish to [dev.to](https://dev.to) from your terminal
[](https://github.com/shihanng/devto/actions?query=workflow%3Amain)
[](https://github.com/shihanng/devto/actions?query=workflow%3Arelease)
[](https://github.com/shihanng/devto/releases)
[](https://coveralls.io/github/shihanng/devto?branch=develop)
[](https://goreportcard.com/report/github.com/shihanng/devto)
[](./LICENSE)
## What is this?
`devto` is a CLI tool that helps submit articles to DEV from the terminal. It makes use of the [APIs that DEV kindly provides in OpenAPI specification](https://docs.dev.to/api/). `devto` mainly does two things:
1. It collects all image links from the Markdown file into a `devto.yml` file with the `generate` subcommand. For example, if we have `./image-1.png` and `./image-2.png` in the Markdown file, we will get the following:
```yml
images:
./image-1.png: ""
./image-2.png: ""
```
2. It submits the article to DEV with the `submit` subcommand. The `submit` subcommand creates a new article in DEV and updates the `devto.yml` with the resulting `article_id`. `devto` will use this `article_id` in the following execution to perform an update operation instead of creating a new entry for the same article.
The DEV API does not have a way of uploading images yet. If we submit a Markdown content with relative paths of image links, DEV will not be able to show those images. As a workaround of this problem, we need to provide a full path for the images either manually via the `devto.yml` file or using the `--prefix` flag.
The Markdown file must contains at least the title property of the Jekyll front matter, like in:
```
---
title: An example title
description: ...
tags: ...
cover_image: ...
---
```
You can find more information about the usage via the `--help` flag.
```sh
devto --help
```
## Installation
### [Homebrew (macOS)](https://github.com/shihanng/homebrew-devto)
```sh
brew install shihanng/devto/devto
```
### Debian, Ubuntu
```sh
curl -sLO https://github.com/shihanng/devto/releases/latest/download/devto_linux_amd64.deb
dpkg -i devto_linux_amd64.deb
```
### RedHat, CentOS
```sh
rpm -ivh https://github.com/shihanng/devto/releases/latest/download/devto_linux_amd64.rpm
```
### Binaries
The [release page](https://github.com/shihanng/devto/releases) contains binaries built for various platforms. Download the version matches your environment (e.g. `linux_amd64`) and place the binary in the executable `$PATH` e.g. `/usr/local/bin`:
```sh
curl -sL https://github.com/shihanng/devto/releases/latest/download/devto_linux_amd64.tar.gz | \
tar xz -C /usr/local/bin/ devto
```
### For Gophers
With [Go](https://golang.org/doc/install) already installed in your system, use `go get`
```sh
go get github.com/shihanng/devto
```
or clone this repo and `make install`
```sh
git clone https://github.com/shihanng/devto.git
cd devto
make install
```
## Configuration
| Description | CLI Flag | Environment Variable | `config.yml` |
| ---------------------------------------------------------------------------------------------- | ----------- | -------------------- | ------------ |
| [DEV API key](https://docs.dev.to/api/#section/Authentication) is needed to talk with DEV API. | `--api-key` | `DEVTO_API_KEY` | `api-key` |
### Sample config in YAML
```yaml
api-key: abcd1234
```
## Contributing
Want to add missing feature? Found bug :bug:? Pull requests and issues are welcome. For major changes, please open an issue first to discuss what you would like to change :heart:.
```sh
make lint
make test
```
should help with the idiomatic Go styles and unit-tests.
### How to generate [DEV's API](https://docs.dev.to/api/) client
```sh
make gen
```
See [`pkg/devto`](./pkg/devto) for client documentation.
## License
[MIT](./LICENSE)