@curvenote/cli
Version:
CLI Client library for Curvenote
36 lines • 1.3 kB
TypeScript
import { LogLevel } from 'myst-cli-utils';
import type { ISession } from '../../session/types.js';
import type { SyncCiHelperOptions } from '../types.js';
/**
* Pull content for a project on a path
*
* Errors if project config does not exist or no remote project url is specified.
*/
export declare function pullProject(session: ISession, path: string, opts?: {
level?: LogLevel;
ci?: boolean;
yes?: boolean;
}): Promise<void>;
/**
* Pull content for all projects in the site config
*
* Errors if no site config is loaded in the state.
*/
export declare function pullProjects(session: ISession, opts: {
level?: LogLevel;
yes?: boolean;
ci?: boolean;
}): Promise<void>;
export declare function pullDocument(session: ISession, file: string): Promise<void>;
/**
* Pull new project content from curvenote.com
*
* If this is called from a folder with an existing site configuration and
* no other path is specified, all projects included in the site are pulled.
* Otherwise, a single project on the specified path is pulled.
*
* Errors if site config has no projects or if project does not exist
* on specified path.
*/
export declare function pull(session: ISession, path?: string, opts?: SyncCiHelperOptions): Promise<void>;
//# sourceMappingURL=project.d.ts.map