Have ideas to improve npm?Join in the discussion! »

    @quaelin/idea-cli

    0.0.3 • Public • Published

    @quaelin/idea-cli

    CLI tool for interacting with the Idea-DAG: decentralized Idea, Relation & Perspective data. Provides convenient command-line access to the idea-api.

    $ npm install -g @quaelin/idea-cli

    This installs the commands idea, relation and perspective.

    Note: For the commands to work, you'll need to have an IPFS daemon running. The commands will look for a daemon running on the default local port (5001), but if your daemon is running elsewhere, use the IDEA_IPFS_HTTP environment variable to specify where it can be found.

    $ export IDEA_IPFS_HTTP=http://localhost:5001/api/v0

    Commands

    Ideas

    idea add

    Create a text Idea, printing its resulting iCid:

    $ idea add "Not a bad idea"
    QmRXZEpbAqbZtj59g7D8rWSFJ6KpAVAVhDRxNAEpwUYW4L

    idea get

    Fetch an Idea (or Relation) by iCid:

    $ idea get QmRXZEpbAqbZtj59g7D8rWSFJ6KpAVAVhDRxNAEpwUYW4L
    Not a bad idea

    Relations

    All of the relation commands are for creating Relations, and they all return the rCid of the created Relation. Use idea get to fetch the Relation object itself.

    relation R:Analogy

    $ relation R:Analogy A=<icid> B=<icid> C=<icid> D=<icid>

    relation R:And

    $ relation R:And A=<icid> B=<icid>

    relation R:Identity

    $ relation R:Identity A=<icid> B=<icid>

    relation R:Implies

    $ relation R:Implies A=<icid> B=<icid>

    relation R:Improves

    $ relation R:Improves A=<icid> B=<icid>

    relation R:IsA

    $ relation R:IsA A=<icid> B=<icid>

    relation R:Negation

    $ relation R:Negation A=<icid>

    relation R:Or

    $ relation R:Or A=<icid> B=>icid>

    relation R:XOr

    $ relation R:XOr A=<icid> B=>icid>

    Perspectives

    In the CLI commands below, a <pex> represents a "perspective expression", which can be either a pCid, or else a literal list of iCid=valuation pairs.

    perspective average

    Merge two or more perspectives together, taking the average valuation for a any given key.

    $ perspective average <pex> <pex> [<pex> ...]

    perspective get

    Fetches the actual content of a perspective.

    $ perspective get <pex>

    The default (and currently only) output format is console.log() style, eg:

    $ perspective get QmdE8HdS615NjvtypfF2FPZc4H7WnS5why67ueUqVdR7tZ
    {
      QmWP7mJwoH9a63yB5YEGnKeVz73Trimn4783w9XCRRM1QA: 0.78,
      QmaFpVwJJc8V4tZLjD3hFTTqTquTR7QFkGy6rYhMEPELva: -0.78
    }

    perspective intersect

    Two or more perspectives can be "intersected", resulting in a new perspective that contains only the iCids common to ALL the input perspectives. The valuations for each kept iCid will be the average of those input.

    $ perspective intersect <pex> <pex> [<pex> ...]

    perspective keys

    Lists just the iCids from a perspective, with no valuations.

    $ perspective keys QmdE8HdS615NjvtypfF2FPZc4H7WnS5why67ueUqVdR7tZ
    [
      'QmWP7mJwoH9a63yB5YEGnKeVz73Trimn4783w9XCRRM1QA',
      'QmaFpVwJJc8V4tZLjD3hFTTqTquTR7QFkGy6rYhMEPELva'
    ]

    perspective merge

    Two or more perspectives can be "merged", resulting in a new perspective with all the iCid:valuation pairs of the constituent perspectives. With merge operations, there is right-to-left precedence. That is, whichever perspective is specified last in the order of arguments is the one whose valuations are used in the case of any duplicate iCids.

    $ perspective merge <pex> [<pex> ...]

    You can also create arbitrary perspectives using perspective merge by specifying a set of iCid=valuation pairs:

    $ perspective merge <icid>=<valuation> [<icid>=<valuation> ...]

    perspective neutralize

    A perspective can be "neutralized", resulting in a new perspective with all valuations set to 0. Neutralizing is the same as polarizing with a polarization factor of -1.

    $ perspective neutralize <pex>

    perspective polarize

    A perspective can be "polarized", where all valuations are adjusted by a <factor> in the range [-1, 1], where:

    • -1 is the same as neutralize (all valuations set to 0)
    • <0 means valuations get skewed towards 0
    • 0 means no change
    • >0 all negative valuations get skewed towards -1, and positive ones towards 1
    • 1 means all negative valuations become -1 and all positive ones become 1
    $ perspective polarize <pex> <factor>

    perspective scope

    You can select a subset of a Perspective A, preserving only the iCids (and valuations) from A where the iCid is found in Perspective B. (Valuations of B are ignored.)

    $ perspective scope <pex A> <pex B>

    perspective skew

    Two perspectives can be merged with a weighting indicating how much to skew valuations towards one or the other.

    $ perspective skew <pex> <pex> <weighting>

    The <weighting> value can be in the range [-1, 1], where for duplicate iCids:

    • -1 means to take the valuation from the first perspective
    • <0 means to skew towards the first
    • 0 means take a straight average
    • >0 means skew towards the second
    • 1 means take the valuation from the second perspective

    Install

    npm i @quaelin/idea-cli

    DownloadsWeekly Downloads

    2

    Version

    0.0.3

    License

    ISC

    Unpacked Size

    18.6 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar