Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 19 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,51 +76,48 @@ tap --help

Create your first keg and start taking notes in under a minute.

**1. Set up configuration**
**1. Initialize a keg**

```bash
tap repo config edit
tap init --keg personal --user
```

Opens your editor with the user config file (`~/.config/tapper/config.yaml`).
Set `fallbackKeg` to `personal` (or your preferred alias) and configure
`kegSearchPaths` so tapper knows where to find your kegs. Save and close.
Creates a keg under your first `kegSearchPaths` entry — or under the
platform user-data directory if no `kegSearchPaths` is configured — and
registers the alias in your user config.

**2. Initialize a keg**
> Tip: run `tap repo config edit` first if you want to set `fallbackKeg`
> (so later commands don't need `--keg`) or customize `kegSearchPaths`.
> Without configuration, tapper picks sensible platform defaults.

```bash
tap repo init --keg personal
```

Creates a keg under your first `kegSearchPaths` entry and registers the alias.

**3. Create a node**
**2. Create a node**

```bash
tap create
tap create --keg personal
```

Opens your editor with a frontmatter template. Write your note, save, and
close. Since `fallbackKeg` is set, no `--keg` flag needed.
close. Set `fallbackKeg` in user config to skip the `--keg` flag on later
commands.

**4. View and edit a node**
**3. View and edit a node**

```bash
tap cat 1
tap cat 1 --keg personal
```

On a terminal this opens the node in your editor for viewing and editing.

**5. List all nodes**
**4. List all nodes**

```bash
tap list
tap list --keg personal
```

**6. Search**
**5. Search**

```bash
tap grep "first"
tap grep "first" --keg personal
```

That's it — you have a working knowledge base. See [More Examples](#more-examples)
Expand Down Expand Up @@ -183,7 +180,7 @@ tap --path ~/Documents/kegs/pub snapshot history 12
Initialize a project-local keg:

```bash
tap repo init --keg tapper --project
tap init --keg tapper --project
```

Create and inspect node history:
Expand Down
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ If you are unsure where to start, read [Configuration Overview](configuration/RE

### Keg operations

- `tap dir [NODE_ID]` — print keg or node directory path
- `tap index rebuild` — rebuild keg indices
- `tap info` — show keg diagnostics
- `tap config` — show active keg config
Expand Down Expand Up @@ -91,7 +90,7 @@ it.

### Repository management

- `tap repo init [--keg ALIAS]` — initialize a keg with repo config
- `tap init [--keg ALIAS]` — initialize a keg target
- `tap repo rm ALIAS` — remove a keg alias
- `tap repo list` — list configured keg aliases
- `tap repo config` — show merged repo config
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/testing-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ sandbox runtime, which acts like an in-memory workflow pipeline.

Example sequence:

1. `tap repo init ...`
1. `tap init ...`
2. `tap create ...`
3. `tap cat ...`

Expand Down
2 changes: 1 addition & 1 deletion docs/keg-structure/domain-separation-and-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ interaction.
Create a user-level destination keg target:

```bash
tap repo init --keg domain-x --user
tap init --keg domain-x --user
```

Inspect and edit new keg config:
Expand Down
2 changes: 1 addition & 1 deletion docs/keg-structure/example-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ graph with project-scoped defaults.
### Bootstrap Commands

```bash
tap repo init --keg tapper --project
tap init --keg tapper --project
tap repo config --project
tap config --project
```
Expand Down
4 changes: 2 additions & 2 deletions pkg/cli/cmd_cat_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ func TestCatCommand_IntegrationWithInit(t *testing.T) {

// First, initialize a user keg
initCmd := NewProcess(innerT, false,
"repo", "init",
"init",
"--user",
"--keg", "newstudy",
"--creator", "test-user",
Expand Down Expand Up @@ -307,7 +307,7 @@ func TestCatCommand_UserKeg(t *testing.T) {

// First, initialize a user keg
initCmd := NewProcess(innerT, false,
"repo", "init",
"init",
"--user",
"--keg", "public",
"--creator", "test-user",
Expand Down
35 changes: 0 additions & 35 deletions pkg/cli/cmd_dir.go

This file was deleted.

65 changes: 0 additions & 65 deletions pkg/cli/cmd_dir_test.go

This file was deleted.

2 changes: 1 addition & 1 deletion pkg/cli/cmd_graph_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ func TestKegGraphCommand_WorksOnProjectKeg(t *testing.T) {
sb.Setwd("~")

initRes := NewProcess(t, false,
"repo", "init", "--project", "--cwd", "--keg", "project", "--creator", "test-user",
"init", "--project", "--cwd", "--keg", "project", "--creator", "test-user",
).Run(sb.Context(), sb.Runtime())
require.NoError(t, initRes.Err)

Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/cmd_index_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ func TestIndexRebuildCommand_IntegrationWithInit(t *testing.T) {
sb := NewSandbox(innerT, opts...)

initCmd := NewProcess(innerT, false,
"repo", "init",
"init",
"--user",
"--keg", "newstudy",
"--creator", "test-user",
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/cmd_info_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func TestConfigCommand_IntegrationWithInit_KegConfig(t *testing.T) {

// First, initialize a user keg
initCmd := NewProcess(innerT, false,
"repo", "init",
"init",
"--user",
"--keg", "newstudy",
"--creator", "test-user",
Expand Down
Loading
Loading