status-im/logos-docs
1
0
Fork 0
mirror of https://github.com/status-im/logos-docs.git synced 2026-08-31 02:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
deploy-develop
logos-docs/core/build-modules/start-a-logos-module-from-the-cli/index.html
T
status-im-auto 077b79eb9f Update documentation
2026-07-26 05:59:32 +00:00

92 lines
31 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-core/build-modules/start-a-logos-module-from-the-cli" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.2"><title data-rh=true>Start a Logos module from the CLI | Logos documentation</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://docs.logos.co/img/social-card.jpg /><meta data-rh=true name=twitter:image content=https://docs.logos.co/img/social-card.jpg /><meta data-rh=true property=og:url content=https://docs.logos.co/core/build-modules/start-a-logos-module-from-the-cli /><meta data-rh=true property=og:locale content=en /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="Start a Logos module from the CLI | Logos documentation"/><meta data-rh=true name=description content="Explore how to load and call a Logos module from the command line using logoscore."/><meta data-rh=true property=og:description content="Explore how to load and call a Logos module from the command line using logoscore."/><link data-rh=true rel=icon href=/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.logos.co/core/build-modules/start-a-logos-module-from-the-cli /><link data-rh=true rel=alternate href=https://docs.logos.co/core/build-modules/start-a-logos-module-from-the-cli hreflang=en /><link data-rh=true rel=alternate href=https://docs.logos.co/core/build-modules/start-a-logos-module-from-the-cli hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.logos.co/core/build-modules/start-a-logos-module-from-the-cli","name":"Start a Logos module from the CLI","position":1}]}</script><link rel=icon href=/img/favicon.png media="(prefers-color-scheme: light)"><link rel=icon href=/img/favicon-dark.png media="(prefers-color-scheme: dark)"><link rel=stylesheet href=/assets/css/styles.e45c7411.css /><script src=/assets/js/runtime~main.ea6c7eaa.js defer></script><script src=/assets/js/main.78385118.js defer></script></head><body><svg style="display: none;"><defs>
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-597")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/img/logo-light.png /><link rel=preload as=image href=/img/logo-dark.png /><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/logo-light.png alt=Logos class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/logo-dark.png alt=Logos class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div></a><a class="navbar__item navbar__link" href=/get-started/what-is-logos>Get started</a><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Your path</a><ul class=dropdown__menu><li><a class=dropdown__link href=/run-an-app>Run an app</a><li><a class=dropdown__link href=/run-a-node/get-started/run-logos-node-blockchain-storage-delivery>Run a node</a><li><a class=dropdown__link href=/build-an-app>Build an app</a><li><a class=dropdown__link href=/contribute/welcome>Contribute</a></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Explore</a><ul class=dropdown__menu><li><a class=dropdown__link href=/basecamp/get-started/install-logos-basecamp>Basecamp</a><li><a class=dropdown__link href=/blockchain/get-started/introduction-to-the-logos-blockchain>Blockchain</a><li><a class=dropdown__link href=/lez/get-started/introduction-to-the-logos-execution-zone>LEZ</a><li><a aria-current=page class="dropdown__link dropdown__link--active" href=/core/build-modules/start-a-logos-module-from-the-cli>Core</a><li><a class=dropdown__link href=/messaging/get-started/introduction-to-logos-messaging>Messaging</a><li><a class=dropdown__link href=/storage/get-started/run-logos-storage-node>Storage</a><li><a class=dropdown__link href=/mixnet/get-started/discover-nodes-and-send-messages-via-the-anoncomms-mixnet-demo-app>Mixnet</a><li><a class=dropdown__link href=/peer-discovery/welcome>Peer discovery</a></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href=https://github.com/logos-co/logos-docs target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role=button aria-expanded=true href=/core/build-modules/start-a-logos-module-from-the-cli><span class=categoryLinkLabel_W154>Build modules</span></a></div><ul class=menu__list><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current=page tabindex=0 href=/core/build-modules/start-a-logos-module-from-the-cli><span class=linkLabel_WmDU>Start a Logos module from the CLI</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/core/build-modules/build-and-run-a-logos-core-module><span class=linkLabel_WmDU>Build and run a Logos core module</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/core/build-modules/wrap-a-c-library-as-a-logos-core-module><span class=linkLabel_WmDU>Wrap a C library as a Logos module</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/core/build-modules/build-a-logos-cpp-ui-module><span class=linkLabel_WmDU>Build a Logos C++ UI module</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/core/build-modules/install-and-load-a-module-in-logos-basecamp><span class=linkLabel_WmDU>Install and load a module in Logos Basecamp</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/core/build-modules/build-logos-core-module-that-uses-service-discovery-api><span class=linkLabel_WmDU>Build a Logos Core module that uses the Service Discovery API</span></a></ul><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role=button aria-expanded=false href=/core/reference/lgx-package-format-and-bundling-reference><span class=categoryLinkLabel_W154>Reference</span></a></div></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_VOVn"><div class=docItemContainer_Djhp><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><span class=breadcrumbs__link>Build modules</span><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Start a Logos module from the CLI</span></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Start a Logos module from the CLI</h1></header>
<h4 class="anchor anchorTargetStickyNavbar_Vzrq" id=explore-how-to-load-and-call-a-logos-module-from-the-command-line-using-logoscore>Explore how to load and call a Logos module from the command line using <code>logoscore</code>.<a href=#explore-how-to-load-and-call-a-logos-module-from-the-command-line-using-logoscore class=hash-link aria-label="Direct link to explore-how-to-load-and-call-a-logos-module-from-the-command-line-using-logoscore" title="Direct link to explore-how-to-load-and-call-a-logos-module-from-the-command-line-using-logoscore" translate=no>​</a></h4>
<p>This guide covers how to build and install a Logos <a href=https://docs.logos.co/get-started/glossary#module target=_blank rel="noopener noreferrer" class="">module</a>, start the <code>logoscore</code> daemon, and call module methods from the command line. It is intended for users who want to run an existing module, or developers who have already built a module binary and want to run it locally for testing or development. By the end you will have a running <code>logoscore</code> instance that loads <a href=https://github.com/logos-co/logos-accounts-module target=_blank rel="noopener noreferrer" class=""><code>accounts_module</code></a> as an example module and returns results for mnemonic generation and relative strength.</p>
<p><strong>Before you start</strong>, make sure you have the following:</p>
<ul>
<li class="">
<p><strong>Nix</strong> with flakes enabled. Install from <a href=https://nixos.org/download.html target=_blank rel="noopener noreferrer" class="">nixos.org</a>, then enable flakes:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">mkdir -p ~/.config/nix</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf</span><br/></div></code></pre></div></div>
<p>Verify: <code>nix flake --help >/dev/null 2>&1 && echo "Flakes enabled"</code></p>
</li>
<li class="">
<p>Git</p>
</li>
<li class="">
<p>Linux or macOS</p>
</li>
<li class="">
<p><a href=https://github.com/logos-co/logos-logoscore-cli/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>logoscore</code></a>, <a href=https://github.com/logos-co/logos-package-downloader/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>lgpd</code></a>, and <a href=https://github.com/logos-co/logos-package-manager/releases/tag/0.2.0 target=_blank rel="noopener noreferrer" class=""><code>lgpm</code></a> installed. To install these tools, use the <code>install-node-tools.sh</code> helper script:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">curl -fsSL https://raw.githubusercontent.com/logos-co/logos-docs/main/resources/scripts/install-node-tools.sh | sh</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">export PATH="$PWD/bin:$PATH"</span><br/></div></code></pre></div></div>
</li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=what-to-expect>What to expect<a href=#what-to-expect class=hash-link aria-label="Direct link to What to expect" title="Direct link to What to expect" translate=no>​</a></h2>
<ul>
<li class="">You can load <code>accounts_module</code> into a running <code>logoscore</code> daemon and call its methods.</li>
<li class="">You can generate a BIP-39 mnemonic phrase and measure its entropy strength with no prior setup.</li>
<li class="">You have a working local <code>modules</code> directory that <code>logoscore</code> can scan for future modules.</li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=install-the-module>Install the module<a href=#install-the-module class=hash-link aria-label="Direct link to Install the module" title="Direct link to Install the module" translate=no>​</a></h2>
<p><code>logoscore</code> expects each module in its own subdirectory containing a <code>manifest.json</code>. The <code>lgpm</code> package manager handles this layout automatically when given an LGX package.</p>
<ol>
<li class="">
<p>Clone the <code>logos-accounts-module</code> repository and build the LGX package:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">git clone https://github.com/logos-co/logos-accounts-module.git</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">cd logos-accounts-module</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">nix build '.#lgx'</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">cd ..</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Create the <code>modules</code> directory and copy the pre-loaded logos modules to it:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">mkdir -p modules</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">cp -RL ./logos/modules/. ./modules/</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Install the LGX package into the <code>modules</code> directory:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">lgpm --modules-dir ./modules install --file ./logos-accounts-module/result/*.lgx</span><br/></div></code></pre></div></div>
<p>After installation, the directory structure looks like this:</p>
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-text codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">modules/accounts_module/</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">├── accounts_module_plugin.dylib # (or .so on Linux)</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">├── manifest.json # Auto-generated by lgx</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">└── variant # Platform variant identifier</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Confirm the module was installed correctly:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">lgpm --modules-dir ./modules list</span><br/></div></code></pre></div></div>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=call-module-methods>Call module methods<a href=#call-module-methods class=hash-link aria-label="Direct link to Call module methods" title="Direct link to Call module methods" translate=no>​</a></h2>
<p>With the module installed, start the <a href=https://github.com/logos-co/logos-logoscore-cli target=_blank rel="noopener noreferrer" class=""><code>logoscore</code></a> daemon, load the module, and call its methods.</p>
<ol>
<li class="">
<p>Start the daemon in the background, pointing it at the modules directory, and wait to initialise:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore -D -m ./modules &</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">sleep 3</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Check the status of <code>logoscore</code>:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore status</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Load the module and confirm that it was loaded:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore load-module accounts_module</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">logoscore list-modules</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Generate a random BIP-39 mnemonic phrase with 12 words:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call accounts_module createRandomMnemonic 12</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Map a mnemonic word count to its entropy strength in bits — for example, 12 words is 128 bits.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore call accounts_module lengthToEntropyStrength 12</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Inspect all available methods in <code>accounts_module</code> with <code>module_info</code>:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore module-info accounts_module</span><br/></div></code></pre></div></div>
</li>
<li class="">
<p>Stop the daemon:</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">logoscore stop</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">sleep 2</span><br/></div></code></pre></div></div>
<p>For inline (legacy) mode and other <code>logoscore</code> options, see the <a href=https://github.com/logos-co/logos-tutorial/blob/tutorial-v4/logos-developer-guide.md#61-running-with-logoscore target=_blank rel="noopener noreferrer" class="">Developer Guide — Running with logoscore</a>.</p>
</li>
</ol>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=troubleshooting-logoscore-module-startup>Troubleshooting <code>logoscore</code> module startup<a href=#troubleshooting-logoscore-module-startup class=hash-link aria-label="Direct link to troubleshooting-logoscore-module-startup" title="Direct link to troubleshooting-logoscore-module-startup" translate=no>​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=the-modules-directory-is-not-found>The modules directory is not found<a href=#the-modules-directory-is-not-found class=hash-link aria-label="Direct link to The modules directory is not found" title="Direct link to The modules directory is not found" translate=no>​</a></h3>
<p>Confirm the module subdirectory exists and contains a <code>manifest.json</code> file. Installing the package again with the correct <code>--modules-dir</code> path resolves this in most cases.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=the-platform-key-in-manifestjson-does-not-match>The platform key in <code>manifest.json</code> does not match<a href=#the-platform-key-in-manifestjson-does-not-match class=hash-link aria-label="Direct link to the-platform-key-in-manifestjson-does-not-match" title="Direct link to the-platform-key-in-manifestjson-does-not-match" translate=no>​</a></h3>
<p><code>logoscore</code> matches the <code>main</code> object in <code>manifest.json</code> against your OS and architecture (for example, <code>linux-aarch64</code> or <code>darwin-arm64</code>). Rebuild the LGX package on the target platform and reinstall.</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=the-daemon-does-not-respond-after-sleep-3>The daemon does not respond after <code>sleep 3</code><a href=#the-daemon-does-not-respond-after-sleep-3 class=hash-link aria-label="Direct link to the-daemon-does-not-respond-after-sleep-3" title="Direct link to the-daemon-does-not-respond-after-sleep-3" translate=no>​</a></h3>
<p>Increase the sleep duration if your machine is slow to initialise, or check for port conflicts by inspecting the daemon's stderr output.</div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href=https://github.com/logos-co/logos-docs/tree/main/docs/core/build-modules/start-a-logos-module-from-the-cli.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href=/core/build-modules/build-and-run-a-logos-core-module><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Build and run a Logos core module</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#what-to-expect class="table-of-contents__link toc-highlight">What to expect</a><li><a href=#install-the-module class="table-of-contents__link toc-highlight">Install the module</a><li><a href=#call-module-methods class="table-of-contents__link toc-highlight">Call module methods</a><li><a href=#troubleshooting-logoscore-module-startup class="table-of-contents__link toc-highlight">Troubleshooting <code>logoscore</code> module startup</a><ul><li><a href=#the-modules-directory-is-not-found class="table-of-contents__link toc-highlight">The modules directory is not found</a><li><a href=#the-platform-key-in-manifestjson-does-not-match class="table-of-contents__link toc-highlight">The platform key in <code>manifest.json</code> does not match</a><li><a href=#the-daemon-does-not-respond-after-sleep-3 class="table-of-contents__link toc-highlight">The daemon does not respond after <code>sleep 3</code></a></ul></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/get-started/what-is-logos>Get started</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/logos-co/logos-docs target=_blank rel="noopener noreferrer" class=footer__link-item>GitHub<svg width=13.5 height=13.5 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 Logos. Built with Docusaurus.</div></div></div></footer></div></body>
Reference in New Issue View Git Blame Copy Permalink