> For the complete documentation index, see [llms.txt](https://docs.learncard.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.learncard.com/sdks/learncard-cli.md).
# LearnCard CLI
**LearnCard CLI** is an easy to use node REPL that instantiates a Learn Card wallet for you and gives you all the tools you need to easily play around with the Learn Card SDK!
### Usage
```bash
npx @learncard/cli
# Optionally specify a deterministic seed to instantiate the wallet with
npx @learncard/cli 1b498556081a298261313657c32d5d0a9ce8285dc4d659e6787392207e4a7ac2
```
### Holder Continuity Export
The CLI also provides REPL helpers from `@learncard/holder-continuity` for holder-controlled continuity exports. These helpers create a standard ZIP with a readable manifest and encrypted payload files for keys, credentials, presentations, consent records, and status-list snapshots.
```javascript
const password = await getLearnCardBundlePassword();
await exportLearnCardBundle(learnCard, {
out: './learncard-export.zip',
password,
});
const freshWallet = await initLearnCard({ seed: '0'.repeat(64), network: true });
await importLearnCardBundle('./learncard-export.zip', {
password,
wallet: freshWallet,
verifyBeforeImport: true,
});
```
```javascript
const restoredWallet = await restoreLearnCardFromBundle('./learncard-export.zip', { password });
```
`getLearnCardBundlePassword()` prompts without echoing the password into the REPL, which avoids saving it in REPL history. You can still pass a password string directly for local scripts.
`restoreLearnCardFromBundle(...)` decrypts the exported seed and returns a wallet with the original DID. It does not upload bundle payloads or recreate index records; use `importLearnCardBundle(...)` when copying credentials into another wallet.
If you omit the first argument, the CLI exports the default `learnCard` wallet it created at startup:
```javascript
const password = await getLearnCardBundlePassword();
await exportLearnCardBundle({ out: './learncard-export.zip', password });
```
Lower-level helpers are also available in the REPL:
```javascript
const password = await getLearnCardBundlePassword();
await createLearnCardBundle(learnCard, { password });
await readLearnCardBundle('./learncard-export.zip', { password });
```
For the data model and portability caveats, see [Holder Continuity](/core-concepts/holder-continuity.md) and the `@learncard/holder-continuity` package `BUNDLE_SPEC.md`.
### Getting Started
Run npx @learncard/cli to boot up the CLI - you should see this screen in your terminal!
From within the CLI, you should be able to start playing around with a basic LearnCard. When the CLI boots up, it creates a default LearnCard called `learnCard` that you can interact with.
### Basic Usage
#### View your wallet's DID
One of the easiest ways to interact with your LearnCard is to get its DID:
```javascript
learnCard.id.did();
// 'did:key:z6MkuWb1dvhvime3BZdiuRGi1Q41o4h4hS5ZUizwBiGw3SU6'
learnCard.id.did('pkh:sol');
// 'did:pkh:sol:G4Ky3gTVPE9a54o2DrJsAJW1yVRDHYqCni61MSJv8Dgi'
learnCard.id.did('tz');
// 'did:tz:tz1Y2Rg8ofGpdGpRqHfix3yy4J6qqK19NE5h'
learnCard.id.did('pkh:tz');
// 'did:pkh:tz:tz1Y2Rg8ofGpdGpRqHfix3yy4J6qqK19NE5h'
```
If your LearnCard is initialized to support more DID methods, such as `did:web`, you could retrieve the corresponding DID through this function.
#### Basic Verifiable Credential Issuance & Verification Flow
Once the CLI has booted up, you can start issuing credentials. Try a basic Verifiable Credential issuance and verification flow, for example:
```javascript
// Create a new, unsigned test Verifiable Credential
const unsignedVerifiableCredential = learnCard.invoke.getTestVc();
/**
{
'@context': [ 'https://www.w3.org/2018/credentials/v1' ],
id: 'http://example.org/credentials/3731',
type: [ 'VerifiableCredential' ],
issuer: 'did:key:z6MkuWb1dvhvime3BZdiuRGi1Q41o4h4hS5ZUizwBiGw3SU6',
issuanceDate: '2020-08-19T21:41:50Z',
credentialSubject: { id: 'did:example:d23dd687a7dc6787646f2eb98d0' }
}
*/
// Then, issue the credential to yourself (i.e. sign the credential to turn it into a verifiable credential)
const signedVerifiableCredential = await learnCard.invoke.issueCredential(
unsignedVerifiableCredential
);
/**
{
'@context': [ 'https://www.w3.org/2018/credentials/v1' ],
id: 'http://example.org/credentials/3731',
type: [ 'VerifiableCredential' ],
credentialSubject: { id: 'did:example:d23dd687a7dc6787646f2eb98d0' },
issuer: 'did:key:z6MkuWb1dvhvime3BZdiuRGi1Q41o4h4hS5ZUizwBiGw3SU6',
issuanceDate: '2020-08-19T21:41:50Z',
proof: {
type: 'Ed25519Signature2018',
proofPurpose: 'assertionMethod',
verificationMethod: 'did:key:z6MkuWb1dvhvime3BZdiuRGi1Q41o4h4hS5ZUizwBiGw3SU6#z6MkuWb1dvhvime3BZdiuRGi1Q41o4h4hS5ZUizwBiGw3SU6',
created: '2022-09-30T15:33:51.015Z',
jws: 'eyJhbGciOiJFZERTQSIsImNyaXQiOlsiYjY0Il0sImI2NCI6ZmFsc2V9..NkaBWEFT2JCU1ZjMSGmbL72EPhVsAsLykAHULee2uh8YdqBqJbti_FmplQQvGnPDy80pbrFRA-IYQQUx11ISCw'
}
}
**/
// Then, verify the credential!
// This verifies that the credential is valid, has not been tampered with, and was issued by the correct DID
await learnCard.invoke.verifyCredential(signedVerifiableCredential);
/**
[
{ status: 'Success', check: 'proof', message: 'Valid' },
{
status: 'Success',
check: 'expiration',
message: 'Valid • Does Not Expire'
}
]
**/
```
#### Basic Verifiable Presentation Issuance & Verification Flow
Now, take the `signedVerifiableCredential` you created in the [VC issuance flow above](#basic-verifiable-credential-issuance-and-verification-flow), and try wrapping it into a Verifiable Presentation, and verifying it.
#### Initialize more LearnCards
At any point, you can initialize additional LearnCards in the CLI, which can be helpful for testing cross-wallet flows:
```javascript
// Initialize an empty LearnCard (cannot sign credentials)
const emptyLC = await initLearnCard();
// Initialize a new LearnCard with deterministically seeded key material
const seededLC = await initLearnCard({ seed: 'abc123' });
```
Check out the docs on [initializing LearnCards](/sdks/learncard-core/construction.md#the-initlearncard-function) for more ways to create a LearnCard.
#### And beyond!
There is a ton of functionality exposed through the CLI. Explore the Usage Examples in LearnCard Wallet SDK:
{% content-ref url="/pages/4umV73ZRVcfyu5TTw8Na" %}
[Usage Examples](/sdks/learncard-core/construction.md)
{% endcontent-ref %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.learncard.com/sdks/learncard-cli.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.