LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Agent
  • Middleware
  • Backends
  • Sandboxes
  • Skills
  • Subagents
  • Configuration
  • Types
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
  • Vitest
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewAgentMiddlewareBackendsSandboxesSkillsSubagentsConfigurationTypes
Modal
Daytona
Deno
Node VFS
Sandbox Standard Tests
Vitest
Language
Theme
JavaScriptdeepagentsindexSettings
Interfaceā—Since v1.4

Settings

Copy
interface Settings

Properties

Methods

View source on GitHub
property
hasProject: boolean
property
projectRoot: string | null
property
userDeepagentsDir: string
method
ensureAgentDir→ string
method
ensureProjectDeepagentsDir→ string | null
method
ensureProjectSkillsDir→ string | null
method
ensureUserSkillsDir→ string
method
getAgentDir→ string
method
getProjectAgentMdPath→ string | null
method
getProjectSkillsDir→ string | null
method
getUserAgentMdPath→ string
method
getUserSkillsDir→ string

Settings interface for project detection and path management.

Provides access to:

  • Project root detection (via .git directory)
  • User-level deepagents directory (~/.deepagents)
  • Agent-specific directories and files
  • Skills directories (user and project level)

Check if currently in a git project

Detected project root directory, or null if not in a git project

Base user-level .deepagents directory (~/.deepagents)

Ensure agent directory exists and return path.

Ensure project .deepagents directory exists.

Ensure project-level skills directory exists and return path.

Ensure user-level skills directory exists and return path.

Get the agent directory path.

Get project-level agent.md path.

Get project-level skills directory path.

Get user-level agent.md path for a specific agent.

Get user-level skills directory path for a specific agent.