Skip to main content

系统范围的组织文件管理器

项目描述

Torgo 是系统范围的组织文件管理器。它允许您创建与您所在的任何目录相关联的组织模式文件,但这些文件是在外部管理的。

用法

usage: torgo [-h] [-l] [-t] [-i] [-p] [command] [param]

Org-file anywhere, managed

positional arguments:
  command      The command to run
  param        Optional param for commands, see commands list for more
               information

optional arguments:
  -h, --help   show this help message and exit
  -l, --list   List the commands available
  -t, --this   Use 'this' directory, don't attempt to find org file in parents
  -i, --init   Force a re-init of the configuration
  -p, --prune  Prune the current org file (delete it)

无论你在哪里运行 torgo,torgo 都会为你所在的目录创建一个托管的 o​​rg-mode 文件。这个 org-mode 文件将存储在一个中心位置,但将与调用 torgo 的目录相关联。

配置

首次运行 torgo 时,它将引导您完成配置文件的创建过程。此配置文件默认为~/.torgo.cfg,但您可以使用$TORGO_CFG环境变量覆盖它。

配置文件定义了以下设置:

  • org_dir: 这是您的 org 文件所在的路径。它默认为~/.torgo/.
  • editor:这是您想要的文本编辑器。如果为空,将尝试 $EDITOR从您的环境中使用。
  • ext:这是所需的 org 文件扩展名。它默认为org.

-i您可以通过传递/--init选项强制 torgo 重新初始化配置 。

它是如何工作的?

也许了解如何使用 torgo 的最好方法是看看它是如何工作的。

当 torgo 运行时,它从当前工作目录开始,并检查其平面数据库文件中是否存在该目录的 org 文件条目(默认情况下,这是~/.torgo/org_lookup_db.json)。如果没有找到 org 文件,它会跳到父目录并在那里检查。它会重复此操作,直到找到 org 文件或到达根目录。如果它到达根目录,那么它将原始工作目录作为 org-mode 的目录。

-t注意:您可以通过传递/--this参数来强制它使用当前工作目录 。

一旦它有适当的 org-mode 文件,它就会在该文件上启动您选择的编辑器。您编辑文件,记笔记或其他任何内容,然后保存。

下次您在同一个目录(或子目录)中启动 torgo 时,它将加载相同的 org-mode 文件。

标记

每个组织文件都可以用任意数量的标签进行标记。要设置或取消设置标签,请使用该tag命令。标签是在标签命令之后的以逗号分隔的参数列表。带有.(句点/点)前缀的标签将被取消设置。要列出给定组织文件的标签,请调用不带任何参数的标签。

> torgo tag foo,bar,baz
> torgo tag
The tags associated with this org file:
    foo
    bar
    baz
> torgo tag .bar
> torgo tag
The tags associated with this org file:
    foo
    baz

search标记后,您可以使用使用标签列表作为其参数的命令搜索具有与给定标签列表关联的 org 文件的所有路径。

> torgo search tag=foo,bar
Found 3 records with the following tags:
	foo
	bar

Path: /home/sam/work/torgo | [oss, python, foo]
Path: /home/sam/work/bigdeal | [bar, work]
Path: /home/sam/meh | [oss, github, dotfiles, foo, bar]

它必须是组织模式文件吗?

不!只需ext将配置文件中的更改为您想要的任何扩展名。Torgo 不会强制您使用任何文件类型,它只是管理与您的目录关联的文件。如果您更愿意以 Markdown、纯文本或其他任何方式记笔记,您可以自由地这样做。

为什么叫托尔戈?

有一段时间,我一直在this.org为我的 ad-hoc org 文件使用一种模式。假设我在一个目录中,该目录是我正在进行的项目的回购,突然需要做笔记 - 我会做一个vim .this.org并在其中写下我的笔记。或者说我正在系统中配置某些东西并且需要记录我正在做的事情 - 同样,我会做一个vim .this.org.

这种模式效果很好,因为无论我在哪里,我总是能够拥有上下文 org-mode 笔记文件。但它有许多缺点。

一方面,它在我的目录中乱扔.this.org文件。如果一个目录是一个 repo,我通常必须添加.this.org到它的忽略文件中。此外,我无法轻松备份或版本控制我的所有.this.org文件。

我创建了一个 hacky shell 脚本,它可以让我在我的主目录中拥有系统范围的 org-mode 文件,这些文件将与我所在的目录的哈希相关联。这让我保持我的this.org模式,但不会乱扔我的目录。它还让我可以对this.org文件进行版本控制并轻松备份它们。

最初,这个 shell 脚本被称为torg(from this.org)。当我开始对其进行改进和扩展时,我最终决定我应该用 Python 重新编写它。因为我是 MST3k 的粉丝,而且因为 Manos The Hands of Fate 是有史以来最伟大的电影,所以从this.org, 到torg, 到torgo.

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

torgo-0.1.2.tar.gz (8.1 kB 查看哈希)

已上传 source

内置分布

torgo-0.1.2-py3-none-any.whl (10.1 kB 查看哈希)

已上传 py3