Metadata-Version: 2.1
Name: frontmatter-cli
Version: 2023.7.1
Summary: Frontmatter CLI tool to make working with frontmatter easier.
Project-URL: Homepage, https://github.com/jefftriplett/frontmatter-cli
Description-Content-Type: text/markdown
License-File: LICENSE

# frontmatter-cli

This is a very early WIP project. My goal is to make working with Frontmatter a little nicer from the command line. The API is going to change, and I plan on adding some other features to make editing Frontmatter easier too.

## Install

```shell
$ python -m pip install frontmatter-cli
```

## Usage

```shell
$ frontmatter-cli --help
Usage: frontmatter-cli [OPTIONS] [EXTRA_CONTEXT]... [INPUT] [OUTPUT]

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  main*

## Echo'ing text as Frontmatter
$ echo "Hello World!" | frontmatter-cli --title="My New Blog Post" - -
---
title: My New Blog Post
---

Hello World!
```

## Contributing

PRs are welcome at <https://github.com/jefftriplett/frontmatter-cli>.

Linting should be verified by running `just lint`. There are currently no tests, so `just test` is expected to fail.

In addition to the development supporting packages that will be installed by `just`, you may need to install the following:

- [just](https://github.com/casey/just#installation)
- [pre-commit](https://pre-commit.com/) `pip install pre-commit`

## Contact / Social Media

Here are a few ways to keep up with me online. If you have a question about this project, please consider opening a GitHub Issue.

[![](https://jefftriplett.com/assets/images/social/github.png)](https://github.com/jefftriplett)
[![](https://jefftriplett.com/assets/images/social/globe.png)](https://jefftriplett.com/)
[![](https://jefftriplett.com/assets/images/social/twitter.png)](https://twitter.com/webology)
[![](https://jefftriplett.com/assets/images/social/docker.png)](https://hub.docker.com/u/jefftriplett/)
