https://github.com/jefftriplett/frontmatter-cli
:fast_forward: Frontmatter CLI tool to make working with frontmatter easier
https://github.com/jefftriplett/frontmatter-cli
cli frontmatter frontmatter-cli python
Last synced: 5 months ago
JSON representation
:fast_forward: Frontmatter CLI tool to make working with frontmatter easier
- Host: GitHub
- URL: https://github.com/jefftriplett/frontmatter-cli
- Owner: jefftriplett
- License: bsd-3-clause
- Created: 2018-01-23T03:05:09.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T14:19:45.000Z (about 3 years ago)
- Last Synced: 2025-08-30T18:15:44.410Z (10 months ago)
- Topics: cli, frontmatter, frontmatter-cli, python
- Language: Python
- Homepage: https://pypi.org/project/frontmatter-cli/
- Size: 85.9 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# 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 .
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://github.com/jefftriplett)
[](https://jefftriplett.com/)
[](https://twitter.com/webology)
[](https://hub.docker.com/u/jefftriplett/)