> ## Documentation Index
> Fetch the complete documentation index at: https://learn.social.plus/llms.txt
> Use this file to discover all available pages before exploring further.

# Vise

> Use the local Vise CLI to guide and validate AI-assisted social.plus SDK integrations.

Vise is a local command-line tool for teams using AI coding agents to integrate social.plus SDKs. It gives the agent a repeatable workflow, grounds the plan in the public docs, writes a local compliance contract, and checks the implementation before you call it done.

Use the hosted MCP server when you want an AI assistant to **find and read documentation**. Use Vise when the assistant is **editing your app** and you want local validation, sensors, and a clear stop condition.

<Info>
  Vise runs on your machine. It fetches public social.plus documentation and SDK version information, but it does not upload your source code, file contents, or search queries.
</Info>

## Who should use Vise

* **Developer using an AI coding agent** — Install the skill, ask for the SDK feature, answer project-specific questions, and let Vise drive the loop through plan, check, and sensors.
* **Technical lead or reviewer** — Review the `sp-vise/` contract, deterministic findings, attestations, and `vise check --ci` result before accepting the integration.
* **Partner or solutions engineer** — Use Vise as a repeatable delivery workflow across customer apps so each integration ends with the same local evidence, not just a prompt transcript.
* **Product or design owner** — Use advisory design and experience outputs to review whether the generated surface fits the product intent. Correctness and explicit completeness checks remain the gates.

## Install

Install Vise globally:

```sh theme={null}
npm install -g @amityco/social-plus-vise
vise doctor
```

Or run it without a global install:

```sh theme={null}
npx -y -p @amityco/social-plus-vise vise doctor
```

## Install the AI skill

Vise includes a bundled skill that teaches your AI coding tool when to inspect, plan, fetch docs, edit code, validate, and ask you for missing decisions.

Choose the target for your tool:

```sh theme={null}
vise install-skill --target claude
vise install-skill --target cursor .
vise install-skill --target vscode .
vise install-skill --target copilot .
vise install-skill --target codex
```

You can also print the skill and paste it into another coding agent:

```sh theme={null}
vise print-skill
```

## Typical workflow

<Steps>
  <Step title="Open your project in your AI coding tool">
    Work inside the app repository where you want to add social.plus SDK features.
  </Step>

  <Step title="Ask for the integration">
    For example: `Add a social feed to this app using the social.plus SDK.`
  </Step>

  <Step title="Let the agent run Vise">
    The skill guides the agent through `vise inspect`, `vise plan`, `vise init`, docs lookup, implementation, `vise check`, and `vise run-sensors`.
  </Step>

  <Step title="Answer project-specific questions">
    Vise asks for values the agent should not invent, such as region, feed target, community ID source, platform scope, or design-system source.
  </Step>

  <Step title="Review the final evidence">
    Done means the local contract is green, attested with evidence, or explicitly blocked on a decision only your team can make.
  </Step>
</Steps>

## What Vise checks

Vise focuses on the mistakes that commonly slip through AI-generated SDK code:

* SDK setup and region configuration
* session renewal and login lifecycle
* secret handling and committed environment files
* Live Object and Live Collection usage
* feed, comment, chat, notification, community, follow, story, and moderation patterns
* feature completeness such as pagination, composers, unread state, and selected optional capabilities
* local project sensors such as build, lint, typecheck, and SDK import smoke checks

Design and experience guidance stays advisory. Deterministic SDK correctness and explicit completeness decisions are the checks that block.

## Vise and the docs MCP server

The two tools work well together:

| Tool            | Best for                                                                       | Runs where                                |
| --------------- | ------------------------------------------------------------------------------ | ----------------------------------------- |
| Docs MCP server | Searching and reading social.plus documentation inside an AI chat              | Hosted at `https://learn.social.plus/mcp` |
| Vise            | Planning, validating, and sensor-running an integration in your app repository | Local CLI in your project                 |

Vise can search the same public docs directly:

```sh theme={null}
vise search-docs "create a text post"
vise get-doc-page social-plus-sdk/social/content-management/posts/creation/text-post
```

## Add Vise to CI

After the first successful integration, commit the generated `sp-vise/` contract with your app and run Vise in CI:

```sh theme={null}
vise check --ci
```

Use `vise check --ci` for read-only verification. Use `vise sync` locally during implementation after a green check to persist deterministic-pass evidence.

## Related docs

<CardGroup cols={2}>
  <Card title="AI / MCP overview" icon="message-bot" href="/ai-mcp/overview">
    Connect your AI tool to the hosted social.plus documentation MCP server.
  </Card>

  <Card title="SDK Quick Start" icon="rocket" href="/social-plus-sdk/getting-started/overview">
    Install and initialize social.plus SDKs for your platform.
  </Card>

  <Card title="Authentication" icon="shield-check" href="/social-plus-sdk/getting-started/authentication">
    Understand user login, session renewal, and regional configuration.
  </Card>

  <Card title="Live Objects and Collections" icon="radio" href="/social-plus-sdk/core-concepts/realtime-communication/live-objects-collections/overview">
    Build realtime SDK features with the correct lifecycle.
  </Card>
</CardGroup>