fs.bookmark - Mesa Docs

Mounted filesystems expose bookmark controls under fs.bookmark.

fs.bookmark.create()

Create a new bookmark on the current commit without switching to it.

await fs.bookmark.create({ repo: 'app', name: 'feature/auth' });

string

required

Repository name.

string

required

Bookmark name.

Move an existing bookmark to point at a change. Moves must advance history unless allowBackwards: true is provided.

const current = await fs.change.current({ repo: 'app' });
await fs.bookmark.move({ repo: 'app', name: 'main', changeId: current.changeId });

string

required

Repository name.

string

required

Bookmark name.

string

required

Change ID to move the bookmark to.

boolean

default:"false"

Allow an intentional backward or sideways move.

List bookmark names for a repository.

const bookmarks = await fs.bookmark.list({ repo: 'app' });
console.log(bookmarks);

string

required

Repository name.

create(...) and move(...) return Promise<void>. list(...) returns Promise<string[]>.