File System

File System

OpenViking provides Unix-like file system operations for managing context.

API Reference

abstract()

Read L0 abstract (~100 tokens summary).

Signature

def abstract(self, uri: str) -> str

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

abstract = client.abstract("viking://resources/docs/")
print(f"Abstract: {abstract}")
# Output: "Documentation for the project API, covering authentication, endpoints..."

client.close()

overview()

Read L1 overview, applies to directories.

Signature

def overview(self, uri: str) -> str

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

overview = client.overview("viking://resources/docs/")
print(f"Overview:\n{overview}")

client.close()

read()

Read L2 full content.

Signature

def read(self, uri: str) -> str

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

content = client.read("viking://resources/docs/api.md")
print(f"Content:\n{content}")

client.close()

ls()

List directory contents.

Signature

def ls(self, uri: str, **kwargs) -> List[Any]

Parameters

Returns

Entry Structure

{
    "name": "docs",           # File/directory name
    "size": 4096,             # Size in bytes
    "mode": 16877,            # File mode
    "modTime": "2024-01-01T00:00:00Z",  # ISO timestamp
    "isDir": True,            # True if directory
    "uri": "viking://resources/docs/",  # Viking URI
    "meta": {}                # Optional metadata
}

Example: Basic Listing

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

entries = client.ls("viking://resources/")
for entry in entries:
    type_str = "dir" if entry['isDir'] else "file"
    print(f"{entry['name']} - {type_str}")

client.close()

tree()

Get directory tree structure.

Signature

def tree(self, uri: str) -> List[Dict]

Parameters

Returns

Entry Structure

[
    {
        "name": "docs",
        "size": 4096,
        "mode": 16877,
        "modTime": "2024-01-01T00:00:00Z",
        "isDir": True,
        "rel_path": "docs/",      # Relative path from base URI
        "uri": "viking://resources/docs/"
    },
    ...
]

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

entries = client.tree("viking://resources/")
for entry in entries:
    type_str = "dir" if entry['isDir'] else "file"
    print(f"{entry['rel_path']} - {type_str}")

client.close()

rm()

Remove file or directory.

Signature

def rm(self, uri: str, recursive: bool = False) -> None

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# Remove single file
client.rm("viking://resources/docs/old.md")

# Remove directory recursively
client.rm("viking://resources/old-project/", recursive=True)

client.close()

mv()

Move file or directory.

Signature

def mv(self, from_uri: str, to_uri: str) -> None

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

client.mv(
    "viking://resources/old-name/",
    "viking://resources/new-name/"
)

client.close()

grep()

Search content by pattern.

Signature

def grep(
    self,
    uri: str,
    pattern: str,
    case_insensitive: bool = False
) -> Dict

Parameters

Returns

Return Structure

{
    "matches": [
        {
            "uri": "viking://resources/docs/auth.md",
            "line": 15,
            "content": "User authentication is handled by..."
        }
    ],
    "count": 1
}

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

results = client.grep(
    "viking://resources/",
    "authentication",
    case_insensitive=True
)

print(f"Found {results['count']} matches")
for match in results['matches']:
    print(f"  {match['uri']}:{match['line']}")
    print(f"    {match['content']}")

client.close()

glob()

Match files by pattern.

Signature

def glob(self, pattern: str, uri: str = "viking://") -> Dict

Parameters

Returns

Return Structure

{
    "matches": [
        "viking://resources/docs/api.md",
        "viking://resources/docs/guide.md"
    ],
    "count": 2
}

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# Find all markdown files
results = client.glob("**/*.md", "viking://resources/")
print(f"Found {results['count']} markdown files:")
for uri in results['matches']:
    print(f"  {uri}")

# Find all Python files
results = client.glob("**/*.py", "viking://resources/")
print(f"Found {results['count']} Python files")

client.close()

link()

Create relations between resources.

Signature

def link(
    self,
    from_uri: str,
    uris: Any,
    reason: str = ""
) -> None

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# Single link
client.link(
    "viking://resources/docs/auth/",
    "viking://resources/docs/security/",
    reason="Security best practices for authentication"
)

# Multiple links
client.link(
    "viking://resources/docs/api/",
    [
        "viking://resources/docs/auth/",
        "viking://resources/docs/errors/"
    ],
    reason="Related documentation"
)

client.close()

relations()

Get relations for a resource.

Signature

def relations(self, uri: str) -> List[Dict[str, Any]]

Parameters

Returns

Return Structure

[
    {"uri": "viking://resources/docs/security/", "reason": "Security best practices"},
    {"uri": "viking://resources/docs/errors/", "reason": "Error handling"}
]

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

relations = client.relations("viking://resources/docs/auth/")
for rel in relations:
    print(f"Related: {rel['uri']}")
    print(f"  Reason: {rel['reason']}")

client.close()

unlink()

Remove a relation.

Signature

def unlink(self, from_uri: str, uri: str) -> None

Parameters

Returns

Example

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

client.unlink(
    "viking://resources/docs/auth/",
    "viking://resources/docs/security/"
)

client.close()

Related Documentation

• Viking URI - URI specification
• Context Layers - L0/L1/L2
• Resources - Resource management