MCPcopy Index your code
hub / github.com/blues/note

github.com/blues/note @v1.9.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.9.0 ↗ · + Follow
754 symbols 2,517 edges 63 files 500 documented · 66%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

NOTEHUB TM

The Blues toolset for manipulating notes and the the basics for creating a hub server.

See also: * note-go for the Go API for communicating with the Notecard + other go tools

How to contribute

Contributions are welcome!

Please read the document How to contribute which will guide you through how to build the source code, run the tests, and contribute your changes to the project.

How to install

Add the package to your go.mod file:

require github.com/blues/note

Or, clone the repository:

git clone --branch master https://github.com/blues/note.git $GOPATH/src/github.com/blues/note

Extension points exported contracts — how you extend this code

EventFunc (FuncType)
EventFunc is the func to get called whenever there is a note add/update/delete
lib/event.go
NoteboxUpdateEnvFunc (FuncType)
NoteboxUpdateEnvFunc is the func to update environment variables for a device
lib/hubreq.go
DiscoverFunc (FuncType)
DiscoverFunc is the func to retrieve discovery info for this server
lib/discover.go
Token (Interface)
A Token holds a value of one of these types: Delim, for the four JSON delimiters [ ] { } bool, for JSON booleans flo
jsonxt/stream.go
Marshaler (Interface)
Marshaler is the interface implemented by types that can marshal themselves into valid JSON.
jsonxt/encode.go
Unmarshaler (Interface)
Unmarshaler is the interface implemented by types that can unmarshal a JSON description of themselves. The input can be
jsonxt/decode.go
FileIO (Interface)
(no doc) [1 implementers]
lib/fileio.go
LogFunc (FuncType)
(no doc)
lib/debug.go

Core symbols most depended-on inside this repo

Close
called by 141
lib/notebox.go
logDebug
called by 108
lib/debug.go
binAppendUint8
called by 81
lib/bulk.go
OpenNotebox
called by 72
lib/notebox.go
Error
called by 42
lib/float16.go
Openfile
called by 34
lib/notebox.go
saveError
called by 29
jsonxt/decode.go
CreateNotebox
called by 28
lib/notebox.go

Shape

Function 347
Method 322
Struct 58
FuncType 11
TypeAlias 10
Interface 4
Class 2

Languages

Go100%
C++1%

Modules by API surface

lib/notehub.pb.go74 symbols
jsonxt/encode.go71 symbols
lib/bulk.go58 symbols
lib/notefile.go54 symbols
lib/notebox.go50 symbols
lib/hubreq.go43 symbols
jsonxt/scanner.go43 symbols
jsonxt/decode.go38 symbols
lib/wire.go32 symbols
jsonxt/stream.go28 symbols
lib/float16.go21 symbols
lib/notehub-defs.go20 symbols

For agents

$ claude mcp add note \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact