hub.md

Hub: get modules and flows from others

What is hub?

The hub is all local dirs linked with ticat, modules will be loaded on bootstrap by scanning these dirs:

 ┌────────────────────────────────┐
 │ Ticat Hub                      │
 │  ┌──────────────────────────┐  │
 │  │ Normal Local Dir         │  │
 │  │ ┌─────┐  ┌─────┐         │  │
 │  │ │ Mod │  │ Mod │  ...    │  │
 │  │ └─────┘  └─────┘         │  │
 │  └──────────────────────────┘  │
 │  ┌──────────────────────────┐  │
 │  │ Repo cloned to Local Dir │  │
 │  │ ┌─────┐                  │  │
 │  │ │ Mod │  ...             │  │
 │  │ └─────┘                  │  │
 │  └──────────────────────────┘  │
 │  ┌──────────────────────────┐  │
 │  │ Repo cloned to Local Dir │  │
 │  │ ┌─────┐  ┌─────┐         │  │
 │  │ │ Mod │  │ Mod │  ...    │  │
 │  │ └─────┘  └─────┘         │  │
 │  └──────────────────────────┘  │
 └────────────────────────────────┘

This command list all dirs in hub:

$> ticat hub

Or find dirs:

$> ticat hub <find-str>

Add a git repo to hub

These dirs could be a git repo, ticat will git clone it to local dir when:

$> ticat hub.add <github-id/repo-name>

or

$> ticat hub.add <git-full-address>

If a repo has sub-repos(what is sub-repo), they will be recursively clone to local too.

All cloned repos store under a specific folder defined by env key sys.paths.hub. These dirs are under ticat's management, are managed dirs.

If we add an existed repo to hub, the repo will be updated by git pull.

Init hub by adding default git address

This command could add the default git address defined by env key sys.hub.init-repo to hub:

$> ticat hub.init

This repo has the most common modules, it's useful for new users.

Update all managed repos

$> ticat hub.update

The disabled repos won't be updated.

Add a local dir to hub

Dirs in hub could be a normal dir added to ticat by:

$> ticat hub.add.local path=<dir>

The dir could be a repo manually cloned to local, ticat treat it as normal dir, they are unmanaged, it means ticat load modules from it but won't change anything in it.

Disable/enable dirs

We use find string as arg, to disable/enable multi dirs in one command:

$> ticat hub.disable <find-str>
$> ticat hub.enable <find-str>

Permanently remove dirs from hub

A dir must be disabled first, then use purge command to remove it:

$> ticat hub.purge <find-str>

This command remove all disabled dirs:

$> ticat hub.purge.all

A managed dir will be totally deleted from file system. A normal(unmanaged) dir will be removed from hub but keep on file system.

All commands about hub

$> ticat h:-
[hub]
     'list dir and repo info in hub'
    [clear]
         'remove all repos from hub'
    [init]
         'add and pull basic hub-repo to local'
    [add-and-update]
         'add and pull a git address to hub'
        [local-dir]
             'add a local dir (could be a git repo) to hub'
    [list]
         'list dir and repo info in hub'
    [purge]
         'remove an inactive repo from hub'
        [purge-all-inactive]
             'remove all inactive repos from hub'
    [update-all]
         'update all repos and mods defined in hub'
    [enable-repo]
         'enable matched git repos in hub'
    [disable-repo]
         'disable matched git repos in hub'
    [move-flows-to-dir]
         'move all saved flows to a local dir (could be a git repo)'