Skip to content

Beaver-Notes/beavernotes-create-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@beaver-notes/create-plugin

Scaffold a new Beaver Notes plugin in seconds.

npx @beaver-notes/create-plugin

Options

npx create-beaver-plugin -y              # skip prompts, use defaults
npx create-beaver-plugin --typescript    # force TypeScript
npx create-beaver-plugin --javascript    # force JavaScript
npx create-beaver-plugin --dir ./my-app  # set output directory

Generated Project

my-plugin/
├── manifest.json        # populated from prompts
├── package.json         # scripts: build, pack, watch, install:local
├── tsconfig.json        # TypeScript config
├── .gitignore
├── README.md
└── src/
    └── index.ts         # typed entry with scaffolded example

Next Steps After Scaffolding

cd my-plugin
npm install              # install SDK + builder
npm run build            # compile
npm run package          # build + create .beax
npm run install:local    # build + install to Beaver Notes

Then open Beaver Notes → Settings → Plugins

License

MIT

About

Scaffold a new Beaver Notes plugin in seconds.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors