obsidian-plugin/yifu-tian_obsidian-codex-workflow
1
0
Fork 0
mirror of https://github.com/yifu-tian/obsidian-codex-workflow.git synced 2026-07-22 06:52:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
5 commits 1 branch 1 tag 34 KiB
JavaScript 90.2%
CSS 9.8%
Find a file
Joseph 831665ab57
Update README.md
2026-05-02 23:49:54 +08:00
.gitignore Initial release 2026-04-27 17:55:56 +08:00
LICENSE Initial release 2026-04-27 17:55:56 +08:00
main.js Initial release 2026-04-27 17:55:56 +08:00
manifest.json Update plugin description 2026-04-27 18:14:26 +08:00
README.md Update README.md 2026-05-02 23:49:54 +08:00
styles.css Initial release 2026-04-27 17:55:56 +08:00
versions.json Initial release 2026-04-27 17:55:56 +08:00

README.md

Codex Workflow

Codex Workflow is a plugin for launching Codex CLI from the current vault.

Manage your Obsidian knowledge base with Codex!

Features

  • Adds a ribbon icon and command to launch Codex CLI
  • Opens Windows Terminal by default
  • Starts in the current Obsidian vault directory
  • Passes a configurable startup prompt to Codex
  • Supports {{vaultPath}} and {{activeFilePath}} variables
  • Includes a compact right-sidebar launcher panel

Installation

This is currently a manual/local plugin. You can install it from the GitHub release assets or from the repository source.

  1. Download or clone this repository.
  2. Copy the repository folder to:
<your-vault>/.obsidian/plugins/codex-workflow
  1. In Obsidian, open Settings -> Community plugins.
  2. Disable Safe mode if needed.
  3. Enable Codex Workflow.

Requirements

  • Obsidian desktop
  • Codex CLI available in your shell path
  • A terminal application

On Windows, the default terminal command is:

wt.exe

The default Codex command is:

codex

Both can be configured in the plugin settings.

Settings

  • Terminal: terminal executable used to open Codex
  • Codex command: command run inside the vault directory
  • Ribbon icon launches terminal: whether clicking the ribbon icon launches immediately
  • Startup prompt: the first prompt passed to Codex

Available startup prompt variables:

  • {{vaultPath}}
  • {{activeFilePath}}

Notes

The plugin writes temporary launch files under:

<your-vault>/.obsidian/plugins/codex-workflow/.tmp

Runtime settings are stored by Obsidian in data.json; this file is intentionally ignored by Git.

Release checklist

For an Obsidian-compatible GitHub release, attach these files:

  • main.js
  • manifest.json
  • styles.css

Contributing

If you have suggestions for improvement or would like to help maintain this project, feel free to open an issue or contact me at yifutian@link.cuhk.edu.cn.