MCPcopy Index your code
hub / github.com/Sharkord/sharkord

github.com/Sharkord/sharkord @v0.0.22

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.0.22 ↗ · + Follow
1,198 symbols 5,328 edges 731 files 2 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Sharkord

A lightweight, self-hosted real-time communication platform

Version License Downloads Last Commit

Bun Mediasoup

ko-fi

What is Sharkord?

[!NOTE] Sharkord is in alpha stage. Bugs, incomplete features and breaking changes are to be expected.

Sharkord is a self-hosted communication platform that brings the most important Discord-like features to your own infrastructure. Voice, video, and screen sharing without the bloat or surveillance.

Docs

For detailed documentation, please visit our Documentation.

Wanna Try It Out?

Check out the Live Demo at demo.sharkord.com.

Getting Started

Sharkord is distributed as a standalone binary that bundles both server and client components. Get started by downloading the latest release for your platform from the Releases page. We ship binaries for Windows, macOS, and Linux.

Linux x64

curl -L https://github.com/sharkord/sharkord/releases/latest/download/sharkord-linux-x64 -o sharkord
chmod +x sharkord
./sharkord

Docker

Sharkord can also be run using Docker. Here's how to run it:

docker run \
  -p 4991:4991/tcp \
  -p 40000:40000/tcp \
  -p 40000:40000/udp \
  -v ./data:/home/bun/.config/sharkord \
  --name sharkord \
  sharkord/sharkord:latest

[!NOTE] Upon first launch, Sharkord will create a secure token and print it to the console. This token allows ANYONE to gain owner access to your server, so make sure to store it securely and do not lose it!

Once the server is running, open your web browser and navigate to http://localhost:4991 to access the Sharkord client interface. If you're running the server on a different machine, replace localhost with the server's IP address or domain name.

Check out our Documentation for more detailed setup instructions, configuration options, and troubleshooting tips.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Built with amazing open-source technologies:

Made with ❤️ by the Sharkord team

<a href="https://github.com/Sharkord/sharkord">GitHub</a> •
<a href="https://github.com/Sharkord/sharkord/issues">Issues</a> •
<a href="https://github.com/Sharkord/sharkord/discussions">Discussions</a>

Extension points exported contracts — how you extend this code

PluginSettings (Interface)
(no doc) [1 implementers]
packages/plugin-sdk/src/index.ts
CommandDefinition (Interface)
(no doc)
packages/shared/src/plugins/index.ts
IconProps (Interface)
(no doc)
packages/ui/src/components/icon.tsx
Window (Interface)
(no doc)
apps/client/src/vite-env.d.ts
WebSocket (Interface)
(no doc)
apps/server/src/declarations.d.ts
EventPayloads (Interface)
(no doc)
packages/plugin-sdk/src/index.ts
ActionDefinition (Interface)
(no doc)
packages/shared/src/plugins/index.ts
SliderProps (Interface)
(no doc)
packages/ui/src/components/slider.tsx

Core symbols most depended-on inside this repo

get
called by 397
packages/plugin-sdk/src/index.ts
error
called by 164
packages/plugin-sdk/src/index.ts
set
called by 152
packages/plugin-sdk/src/index.ts
invariant
called by 140
apps/server/src/utils/invariant.ts
cn
called by 123
packages/ui/src/lib/utils.ts
getTRPCClient
called by 112
apps/client/src/lib/trpc.ts
logVoice
called by 105
apps/client/src/helpers/browser-logger.ts
cn
called by 71
apps/client/src/lib/utils.ts

Shape

Function 1,054
Class 44
Method 44
Enum 29
Interface 27

Languages

TypeScript100%

Modules by API surface

apps/client/src/features/server/sounds/actions.ts26 symbols
apps/client/src/features/server/hooks.ts26 symbols
apps/client/src/features/app/actions.ts25 symbols
apps/client/src/features/app/selectors.ts22 symbols
apps/client/src/features/app/hooks.ts18 symbols
packages/ui/src/components/dropdown-menu.tsx15 symbols
packages/ui/src/components/context-menu.tsx15 symbols
apps/server/src/utils/wss.ts15 symbols
packages/e2e/tests/infinite-scroll.pw.ts14 symbols
apps/client/src/features/server/actions.ts14 symbols
apps/client/src/helpers/storage.ts13 symbols
apps/client/src/features/server/voice/actions.ts13 symbols

For agents

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

⬇ download graph artifact

Ask about this repo answers extend the page